Skip to main content
GET
cURL
With this endpoint you can get the report data grouped by promoters. Data is updated once a day, at midnight. This endpoint supports pagination, similar to other endpoints, by passing page param.

If you want to iterate through all promoters, you must start with page=1 and continue to next pages based on header pagination links from the response. The paginated promoters are always ordered by the total revenue made (not the revenue brought during the selected period).

If page param is omitted, we’ll return top 50 promoters by revenue amount on the selected period. You can get the top 50 promoters sorted by a different metric using the top_50 parameter.

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
promoter_ids[]
string[]

An array of ids of the selected Promoters. If omitted, all Promoters will be returned

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
top_50
enum<string>

Show the top 50 promoters by selected metric. By default is revenue_amount but it can be any value passed on selected_fields[].

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
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

Promoter report response

promoter_name
string

Promoter's name

Example:

"Test Promoter"

promoter_id
number

ID of the promoter

Example:

5487437

items
object[]
revenue_amount
string
Example:

"$613.17"

clicks_count
number
Example:

100

referrals_count
number
Example:

60

customers_count
number
Example:

30