GET
/
reports
/
promoters
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/reports/promoters \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "promoter": {
      "id": 123,
      "email": "[email protected]",
      "name": "<string>"
    },
    "id": 123,
    "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
    },
    "sub_data": [
      {
        "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

Fields to be included in the report

​
q
string

Search query string

​
group_by
enum<string>
required

Time period grouping

Available options:
day,
week,
month,
year
​
start_date
string
required

Start date for the report period

​
end_date
string
required

End date for the report period

​
sorting
object

Sorting parameters

Response

200
application/json

Successful response

The response is of type object[].