Skip to main content
GET
/
reports
/
overview
Get reports for overview
curl --request GET \
  --url https://api.firstpromoter.com/api/v2/company/reports/overview \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "period": "<string>",
    "id": "<string>",
    "data": {
      "revenue_amount": 123,
      "net_revenue_amount": 123,
      "promoter_earnings_amount": 123,
      "customers_count": 123,
      "referrals_count": 123,
      "clicks_count": 123,
      "active_customers": 123,
      "3m_epc": 123
    }
  }
]

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations → Manage API Keys

Headers

​
Account-ID
string
required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Example:

"acc_123456"

Query Parameters

​
columns
enum<string>[]
required
Available options:
active_customers,
monthly_churn,
clicks_count,
net_revenue_amount,
revenue_amount,
referrals_count,
customers_count,
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,
signups_count
​
q
string
​
group_by
enum<string>
required
Available options:
day,
week,
month,
year
​
start_date
string<date-time>
required
​
end_date
string<date-time>
required
​
sorting
object

Response

Successful response

​
period
string
​
id
string
​
data
object