Skip to main content
GET
Download reports

Authorizations

Authorization
string
header
required

Your affiliate API key (Profile → API & AI tools in the affiliate dashboard), sent as Authorization: Bearer {api_key}

Headers

Account-ID
string
required

Account ID of the affiliate program, shown next to your API key under Profile → API & AI tools

Example:

"acc_123456"

Query Parameters

report_type
enum<string>
required
Available options:
overview,
traffic_sources,
urls,
sub_ids
totals
boolean
columns
string[]
required
group_by
enum<string>
required
Available options:
day,
week,
month,
year
start_date
string<date-time>
required
end_date
string<date-time>
required

Response

Successful response

The response is of type string.