GET
/
payouts
/
stats
Get payout stats
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/payouts/stats \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "net_payout_days": 123,
    "payout_cycle": "<string>",
    "min_payment": 123,
    "min_paying_customers": 123,
    "terms_description": "<string>",
    "selected_payout_methods": [
      "<string>"
    ],
    "payout_method_options": {},
    "managed_payouts": true
  },
  "data": {
    "by_paid_period": [
      {
        "period_start": "2023-11-07T05:31:56Z",
        "period_end": "2023-11-07T05:31:56Z",
        "promoters_count": 123,
        "amounts": {},
        "total_incl_tax": 123
      }
    ],
    "by_status": {},
    "by_payout_method": {}
  }
}

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

200
application/json

Successful response

The response is of type object.