v1
latestOpenAPI 3.0.02026-07-264731126.7 KBReports
Get reports for promoters
With this endpoint you can get the report data grouped by promoters.<Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/reports/promoters</Tip>
get/reports/promoters
Query parameters
columnsstring[] required
Fields to be included in the report
qstring
Search query string
group_by'day' | 'week' | 'month' | 'year' required
Time period grouping
start_datestring date-time required
Start date for the report period
end_datestring date-time required
End date for the report period
sortingobject
Sorting parameters
Headers
Account-IDstring required
Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
Response
Successful response