Reference for common API request parameters.
Parameters accepted by GET /api/v1/offers.
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey |
string | Yes | Your app's API key. |
apiSecret |
string | Yes | Your app's API secret. Server-side only. |
userId |
string, max 256 | Optional | Your end user identifier. Used to build the tracking link and attribute the conversion. Strongly recommended — without it the returned tracking links carry a placeholder and conversions cannot be matched back to your user. |
country |
string, exactly 2 characters | Optional | Two-letter country code to filter by. Defaults to the country Preads detects for the caller, which is not necessarily your user's country. |
platform |
web, android or ios |
Optional | Filter by platform. Defaults to the detected device type, so leave it unset unless you specifically want to override detection. |
category |
string | Optional | Filter by offer category. |
limit |
integer, 1–100 | Optional | How many offers to return. Default 20. |
offset |
integer, 0 or more | Optional | Pagination offset. Default 0. |
sort |
payout_desc, payout_asc or newest |
Optional | Ordering. Default payout_desc — highest earning first. |
Any value outside these ranges returns 422 INVALID_PARAMETERS with the offending
fields named. See Responses.
Parameters accepted by GET /api/track, which registers a click and redirects to the
advertiser. You normally do not call this yourself — use the link returned by the
offers endpoint.
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey |
string | Yes | Your app's API key. |
userId |
string, max 256 | Yes | Required here, unlike on the wall. Without it the click fails validation and nothing is tracked. |
offerId |
integer | Yes | The offer being clicked. |
aff_sub |
string, max 255 | Optional | Your campaign or placement value. Echoed back to your postback. |
aff_sub2 – aff_sub4 |
string, max 255 | Optional |
Three further values, echoed back as {aff_sub2} –
{aff_sub4}.
|
fingerprint |
string, max 255 | Optional | Device fingerprint hash. Reduces false rejections from fraud detection. The embedded wall supplies this automatically. |
Note the parameter name is offerId here, camelCase — unlike most other parameters.
And there is no subId parameter on this endpoint; use aff_sub.