Retrieving top contributions
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution
Method: GET
Parameters:
| Field | Value Type | Description |
|---|---|---|
size | integer($int32) | The number of entries, starting with the latest, shown in the response. Set to 50 by default. |
from and to | string | The timeframe that the response entries are filtered by (set as Unix Epoch time in seconds). The from parameter is set to 0 by default. |
ft | array[string] | The type of the fraud event. Could be one of the following:
|
org | array[string] | The country of origination of the fraud event. Set as a two-digit country code (Alpha-2, ISO 3166; e.g., US, GA) |
self-only | boolean | A boolean that defines whether the response should only contain contributions submitted by the requesting peer. The self-only parameter is set to false by default. |
fetch-mode | string | The parameter that filters the response entries based on whether the requesting user has already seen them. Could be one of the following:
DEFAULT — includes all of the entries.The fetch-mode parameter is set to DEFAULT by default. |
fetch-mode | string | The parameter that filters the response entries based on whether the requesting user has already seen them. Could be one of the following:
The fetch-mode parameter is set to DEFAULT by default. |
confidence-score | boolean | A boolean that defines whether the price of the retrieved contributions is affected by the confidence index. If set to true, the price of any given contribution is expected to rise above the default conversion rate. The confidence-score parameter is set to false by default. |
Input/request structure:
A GET request to the endpoint.
Output/response structure:
Show
json5
{
status: {
code: 0, //integer($int32)
name: 'string',
message: 'string'
},
data: {
contributions: [
{
id: 'string',
fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
origination: 'string',
destination: 'string',
expiryDate: 0, //integer($int32)
fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
confidenceIndex: 0, //number($double)
isPremium: true, //boolean
peerId: 'string',
flagger: 'string',
premium: true //boolean
}
],
details: {
self: 0,
old: 0,
new: 0,
creditsSpent: 0
}
}
}{
status: {
code: 0, //integer($int32)
name: 'string',
message: 'string'
},
data: {
contributions: [
{
id: 'string',
fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
origination: 'string',
destination: 'string',
expiryDate: 0, //integer($int32)
fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
confidenceIndex: 0, //number($double)
isPremium: true, //boolean
peerId: 'string',
flagger: 'string',
premium: true //boolean
}
],
details: {
self: 0,
old: 0,
new: 0,
creditsSpent: 0
}
}
}Responses
| Response Code | Description |
|---|---|
200 | Contributions have been successfully retrieved and filtered by the specified parameters. |
400 | Request parameters are invalid or the fraud type could not be resolved by code. |
404 | Contribution subscription has not been found. |
500 | Internal server error. |