Sign in
Statistics

Retrieve All Statistics

Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.

get/statistics

Headers

X-Wallet-Idstring

Optional. Narrows the statistics to a single distribution account. Naming an account outside your access returns 404 rather than disclosing that it exists. Omit it to cover every account you have access to.

Response

General Statistics response

total_disbursementsinteger

Total number of disbursements

total_receiversinteger

Total number of receivers

Example response

{
  "total_disbursements": 20,
  "payment_counters": {
    "draft": 1,
    "ready": 2,
    "pending": 3,
    "paused": 1,
    "success": 5,
    "failed": 1,
    "total": 14
  },
  "payment_amounts_by_asset": [
    {
      "asset_code": "USDC",
      "asset_issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
      "payment_amounts": {
        "draft": "100.00",
        "ready": "200.00",
        "pending": "300.00",
        "paused": "100.00",
        "success": "500.00",
        "failed": "100.00",
        "average": "100.00",
        "total": "1400.00"
      }
    }
  ],
  "receiver_wallets_counters": {
    "draft": 1,
    "ready": 1,
    "registered": 1,
    "flagged": 1,
    "total": 4
  },
  "total_receivers": 1000
}

Changes