Skip to main content
GET
cURL

Authorizations

X-API-KEY
string
header
required

Query Parameters

selected_fields[]
enum<string>[]

An array of fields to return on the response. By default selected fields are revenue_amount, clicks_count, referrals_count, customers_count.

Available options:
revenue_amount,
clicks_count,
referrals_count,
customers_count,
active_customers,
monthly_churn,
net_revenue_amount,
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
group_by
enum<string>

Period to group by. By default is month. For day grouping, reporting period span is limited at 90 days

Available options:
day,
month,
year
start_date
string

Beginning of reporting period. Default is set as 12 months ago

end_date
string

End of reporting period. Default is set as today

Response

Campaign report response

campaign_name
string

Name of the campaign

Example:

"Test Campaign"

campaign_id
number

ID of the Campaign

Example:

18519

items
object[]
revenue_amount
string
Example:

"$613.17"

clicks_count
number
Example:

100

referrals_count
number
Example:

60

customers_count
number
Example:

30