v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Get payout stats

This endpoint returns statistics about payouts. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/payouts/stats</Tip>

get/payouts/stats

stats_by[paid_period]boolean

Shows the stats by payout period only for paid payouts

stats_by[status]boolean

Shows the stats by status (pending, failed, processing, completed)

stats_by[payout_method]boolean

Shows the stats by payout method

filters[status]'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'

Filter by status

integer

integer[]

Campaign ids. Can be Integer or Array of Integers

Account-IDstring required

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

Successful response