Get publisher redemptions

Returns one row per event for a publisher platform, enriched with campaign, device and location context. Every event type is returned unless you filter with name. Rows are ordered by timestamp, then sessionId, then name, ascending.

To page through results, leave cursor out of the first request, then pass back pagination.nextCursor until it is null.

A conversion's status and commission can change after it first appears, and an update arrives as a new conversion row. Re-pull a recent window to pick up changes, using insertedAfter to fetch only rows added since your last pull. conversion and settled-conversion rows describe the same sale, so don't add them together.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The platform ID for your publisher

Query Params
date
required

Start of date range (inclusive, UTC) in YYYY-MM-DD format

date
required

End of date range (inclusive, UTC) in YYYY-MM-DD format

name
array of strings

Only return events with these names, for example conversion, settled-conversion, ad-action or phase. Repeat the parameter for several names. Returns every event type when omitted.

name
integer
1 to 10000
Defaults to 100

Number of rows to return (1-10,000). Defaults to 100.

string

Opaque token for the next page, taken from pagination.nextCursor in the previous response. Leave it out of the first request; an empty or malformed value returns 400. Takes precedence over offset when both are sent.

integer
≥ 0
Defaults to 0
deprecated

Deprecated, use cursor instead. Number of rows to skip. Increment by limit until offset >= totalRecords.

date-time

Only return rows added to our records after this UTC time (ISO 8601, ending in Z). Pass the largest insertedAt from your previous pull to fetch only new rows, including events that arrived late for an earlier timestamp.

include
array of strings

Optional fields to add to each row. Comma-separated or repeated. traceId adds the traceId you sent for the session. settlement adds settledStatus and settledAt, showing whether and when each conversion was approved or declined. An unknown value returns 400.

include
Allowed:
Responses

401

Missing or invalid API key

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json