Skip to main content
GET
Get payout stats

Authorizations

Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

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]
enum<string>

Filter by status

Available options:
pending,
completed,
failed,
processing,
cancelled
filters[campaign_id]

Campaign ids. Can be Integer or Array of Integers

Response

Successful response

meta
object
data
object