v2
latestOpenAPI 3.0.02026-08-04911995.6 KBAnalytics
Get Affiliate Analytics
Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.
get/analytics/affiliates
Query parameters
limitnumber
Example:100
How many affiliates to return, from 10 to 100.
offsetnumber
How many affiliates to skip before the page.
fromstring date required
Example:2026-01-01
The first day of the period, inclusive, as YYYY-MM-DD (UTC).
tostring date required
Example:2026-03-31
The last day of the period, inclusive, as YYYY-MM-DD (UTC). Must not be before from, and the period must be at most 90 days long.
Headers
x-api-keystring required
The secret API key.
Response
The page of affiliates and their totals for the period.
Example response
{
"data": {
"from": "2026-01-01",
"to": "2026-03-31",
"totals": {
"claims": 120,
"conversions": 34,
"revenue": 249900,
"earnings": 49980
},
"affiliates": [
{
"id": "2772aded-9009-474c-a368-c887dda45b01",
"name": "Jane Doe",
"accepted_at": "2026-01-01T00:00:00.000Z",
"status": "approved",
"totals": {
"claims": 120,
"conversions": 34,
"revenue": 249900,
"earnings": 49980
}
}
],
"pagination": {
"limit": 100,
"total": 512,
"has_more": true
}
}
}