---
title: "Get payout stats"
method: GET
path: "/payouts/stats"
---

# Get payout stats

`GET /payouts/stats`

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

## Query parameters

- `stats_by[paid_period]` boolean
- `stats_by[status]` boolean
- `stats_by[payout_method]` boolean
- `filters[status]` 'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'
- `filters[campaign_id]` union
  - integer
  - integer[]

## Headers

- `Account-ID` string, required

## Response `200`

Successful response

- PayoutStats
  - `meta` object
    - `net_payout_days` integer — Number of days for net payout
    - `payout_cycle` string — Payout cycle (e.g., monthly)
    - `min_payment` integer — Minimum payment amount
    - `min_paying_customers` integer — Minimum number of paying customers
    - `terms_description` string — Description of payment terms
    - `selected_payout_methods` string[] — List of selected payout methods
    - `payout_method_options` object — Options for payout methods
    - `managed_payouts` boolean — Whether payouts are managed by us (auto-payouts)
  - `data` object
    - `by_paid_period` object[]
      - `period_start` string, date-time — Start date of the period
      - `period_end` string, date-time — End date of the period
      - `promoters_count` integer — Count of promoters
      - `amounts` object — Amounts by currency or unit
      - `total_incl_tax` number — Total amount including tax
    - `by_status` object
    - `by_payout_method` object

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api.md) · [All operations](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firstpromoter/firstpromoter-batch-processes-api/versions/e15f0d026ccf/schema)