GET
/
promoters
cURL
curl --request GET \
  --url https://firstpromoter.com/api/v1/reports/promoters \
  --header 'X-API-KEY: <api-key>'
[
  {
    "promoter_name": "Test Promoter",
    "promoter_id": 5487437,
    "items": [
      {
        "revenue_amount": "$613.17",
        "clicks_count": 100,
        "referrals_count": 60,
        "customers_count": 30,
        "period": "Sep 2024"
      }
    ],
    "revenue_amount": "$613.17",
    "clicks_count": 100,
    "referrals_count": 60,
    "customers_count": 30
  }
]

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

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

200
application/json

Promoter report response

The response is of type object[].