Skip to main content
GET
Get reports for traffic sources

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

Available options:
clicks_count,
revenue_amount,
promoter_earnings_amount,
referrals_count,
customers_count,
sales_count,
refunds_count,
cancelled_customers_count,
referrals_to_customers_cr,
clicks_to_customers_cr,
clicks_to_referrals_cr
q
string

Search query string

group_by
enum<string>
required

Time period grouping

Available options:
day,
week,
month,
year
start_date
string<date-time>
required

Start date for the report period

end_date
string<date-time>
required

End date for the report period

sorting
object

Sorting parameters

Response

Successful response

source
string
id
string
data
object
sub_data
object[]