Retrieving contributions
Retrieves the contributions stored on the network as JSON strings in accordance with the parameters specified in the request.
This operation is treated as downloading contributions, i.e., the tokens balance of the user signed in via API is affected in accordance with the current conversion rate.
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution
Method: GET
Header: Authorization — represented by a string that is the accessToken value that was returned either at the authorization, or the previous time the token has been refreshed.
Parameters:
The following parameters can be specified with the request to filter the retrieved results.
| 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. Can be one of the following:
|
org | array[string] | The country of origination of the fraud event. Set as a two-letter 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. Can 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 might rise above the default conversion rate. To retrieve the currently established prices, try retrieving download pricing rate. The confidence-score parameter is set to false by default. |
Input/request structure
A GET request to the endpoint with the Authorization header specified.
Output/response structure
Show
json5
{
status: {
code: integer($int32),
name: 'string'
},
data: {
contributions: [
{
id": 'string',
fraudType: 'string',
origination: 'string',
destination: 'string',
expiryDate: integer($int32),
fraudStatus: 'string(enum)',
confidenceIndex: number($double),
isPrivileged: boolean,
peerId: 'string',
flagger: 'string',
timestamp: integer($int32)
}
],
details: {
self: integer($int32),
old: integer($int32),
new: integer($int32),
newWithConfidenceIndex: integer($int32),
creditsSpent: integer($int32),
balanceLeft: integer($int32),
contributionsNotReturned: integer($int32),
contributionsNotReturnedCost: integer($int64)
}
}
}{
status: {
code: integer($int32),
name: 'string'
},
data: {
contributions: [
{
id": 'string',
fraudType: 'string',
origination: 'string',
destination: 'string',
expiryDate: integer($int32),
fraudStatus: 'string(enum)',
confidenceIndex: number($double),
isPrivileged: boolean,
peerId: 'string',
flagger: 'string',
timestamp: integer($int32)
}
],
details: {
self: integer($int32),
old: integer($int32),
new: integer($int32),
newWithConfidenceIndex: integer($int32),
creditsSpent: integer($int32),
balanceLeft: integer($int32),
contributionsNotReturned: integer($int32),
contributionsNotReturnedCost: integer($int64)
}
}
}json5
{
status: {
code: 200,
name: 'Ok'
},
data: {
contributions: [
{
id: '127.0.0.1-127.0.0.1',
fraudType: 'IPFraud',
origination: 'UA',
destination: 'GB',
expiryDate: 1711373543,
fraudStatus: 'Active',
confidenceIndex: null,
isPrivileged: false,
peerId: 'test',
flagger: null,
timestamp: xxx,
flagTimestamp: 1711891326
},
{
id: '127.0.0.1-127.0.0.1',
fraudType: 'IPFraud',
origination: 'GA',
destination: 'RU',
expiryDate: 1711372367,
fraudStatus: 'Flagged',
confidenceIndex: null,
isPrivileged: false,
peerId: 'test',
flagger: 'admin@test',
timestamp: xxx,
flagTimestamp: 1711977724
}
],
details: {
self: 6,
old: 19,
new: 123,
creditsSpent: 190,
balanceLeft: 50,
contributionsNotReturned: 1
}
}
}{
status: {
code: 200,
name: 'Ok'
},
data: {
contributions: [
{
id: '127.0.0.1-127.0.0.1',
fraudType: 'IPFraud',
origination: 'UA',
destination: 'GB',
expiryDate: 1711373543,
fraudStatus: 'Active',
confidenceIndex: null,
isPrivileged: false,
peerId: 'test',
flagger: null,
timestamp: xxx,
flagTimestamp: 1711891326
},
{
id: '127.0.0.1-127.0.0.1',
fraudType: 'IPFraud',
origination: 'GA',
destination: 'RU',
expiryDate: 1711372367,
fraudStatus: 'Flagged',
confidenceIndex: null,
isPrivileged: false,
peerId: 'test',
flagger: 'admin@test',
timestamp: xxx,
flagTimestamp: 1711977724
}
],
details: {
self: 6,
old: 19,
new: 123,
creditsSpent: 190,
balanceLeft: 50,
contributionsNotReturned: 1
}
}
}INFO
For a detailed breakdown of every field and value in the body of a response, see Contributions: Retrieving contributions.
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. |
401 | accessToken is either expired or invalid. |
404 | Contribution subscription has not been found. |
500 | Internal server error. |