15 minutes
GET https://firstpromoter.com/api/v1/reports/overview
An array of fields to return on the response. By default selected fields are revenue_amount
, clicks_count
, referrals_count
, customers_count
.
Field used for sorting. If is not passed it takes the first field from selected_fields[]
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
Sorting direction. By default is desc
.
asc
, desc
Period to group by. By default is month
. For day grouping, reporting period span is limitd at 90 days
day
, month
, year
Beginning of reporting period. Default is set as 12 months ago
End of reporting period. Default is set as today
Overview report response
The response is of type object[]
.