Skip to main content
GET
Get data used for chart

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 section → Manage API Keys

Headers

Account-ID
string
required

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

Path Parameters

id
integer
required

Id of the promoter

Query Parameters

period_from
string<date>
required

From date of the period for the chart, ISO date format (YYYY-MM-DD)

period_to
string<date>
required
selection
enum<string>
required
Available options:
revenue,
clicks,
referrals,
customers,
cancellations

Response

Chart data retrieved successfully

period_from
string<date>

Start date of the chart data period

period_to
string<date>

End date of the chart data period

selection
enum<string>

Type of data being displayed

Available options:
revenue,
clicks,
referrals,
customers,
cancellations
selection_items
((string | number)[])[]

Data points for the chart

A date-value pair

Required array length: 2 elements

Date label for the data point (format depends on group_by)

group_by
enum<string>

Time unit used for grouping the data

Available options:
day,
week,
month,
year