Skip to main content
GET
Get campaigns 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

columns
enum<string>[]
required
Available options:
active_customers,
monthly_churn,
clicks_count,
net_revenue_amount,
revenue_amount,
referrals_count,
customers_count,
sales_count,
refunds_count,
cancelled_customers_count,
promoter_earnings_amount,
non_link_customers,
referrals_to_customers_cr,
3m_epc,
6m_epc,
clicks_to_customers_cr,
clicks_to_referrals_cr,
promoter_paid_amount,
signups_count
q
string
group_by
enum<string>
required
Available options:
day,
week,
month,
year
start_date
string<date-time>
required
end_date
string<date-time>
required
sorting
object

Response

Successful response

period
string
id
string
data
object