Skip to main content
GET
/
overview
cURL
curl --request GET \
  --url https://firstpromoter.com/api/v1/reports/overview \
  --header 'X-API-KEY: <api-key>'
[
  {
    "revenue_amount": "$613.17",
    "clicks_count": 100,
    "referrals_count": 60,
    "customers_count": 30,
    "period": "Sep 2024"
  }
]

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

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
​
sort
enum<string>

Field used for sorting. If not passed, it takes the first field from 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
​
sort_dir
enum<string>

Sorting direction. By default is desc.

Available options:
asc,
desc
​
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

Overview report response

​
revenue_amount
string
Example:

"$613.17"

​
clicks_count
number
Example:

100

​
referrals_count
number
Example:

60

​
customers_count
number
Example:

30

​
period
string
Example:

"Sep 2024"