# Read your platform's figures.

> What your sellers sold, what your platform kept, what it stands to lose and what your sellers were paid, over `period` (UTC days, today included) against the period of the same length just before. Every amount is in major units and per currency: money is never added across currencies. The same figures as the Dashboard's Sync › Analytics, read from the same ledger rows; kept for a minute.

`GET https://api.wajub.com/sync/metrics`

What your sellers sold, what your platform kept, what it stands to lose and what your sellers were paid, over `period` (UTC days, today included) against the period of the same length just before. Every amount is in major units and per currency: money is never added across currencies. The same figures as the Dashboard's Sync › Analytics, read from the same ledger rows; kept for five minutes.

What happened over the period (sales, commission, payouts made, disputes opened, covers) is complete up to `as_of`, usually a minute or two before the call; what stands now (reserves, held sales, open disputes, payouts on their way, what your sellers are owed and hold) is read when the figures are worked out. Call it in the background (a scheduled job of yours), not at every page view. Another call for the same figures while they are being worked out waits a few seconds, then gets `429 metrics_busy` with `Retry-After`. When the period's figures cannot be read for a moment (`metrics_unavailable`), or cannot be worked out in time (`metrics_timeout`), the call answers `503` with `Retry-After`. The route has its own limit: 10 calls a minute per platform and environment (`429`).

- `volume`: your sellers' collected sales (payments made with `X-Sync` on your accounts) and the settled parts of your shared payments, by currency and mode (`direct`, `lite`, `relay`); `shared_percent` is the share of the volume that came through shared payments; `active_sellers` counts the accounts with at least one sale.
- `commission`: taken on those sales (a Relay sale's commission is the one its due recorded), `returned` by refunds and lost disputes, `forgone` (what a return capped at your balance left with you), `net` (taken − returned) and `take_rate` (net over the volume, in percent).
- `risk`: `exposure` as `GET /sync/limits` gives it (empty in sandbox), the sellers' `reserve` (the Lite rolling reserve and the card reserve; `reserve[].card`: what card sales of your Lite and Relay sellers keep against chargebacks, how many, and the next release), the sales held until delivery (`escrow`, and what is released on its own within 7 days), the refunds you `covers`ed and what came back, your Lite and Relay sellers by risk level, and the disputes on their sales (running now, and `rate`: opened in the period over the period's sales, percent).
- `payouts`: what Wajub paid your sellers in the period, what is on its way, what your Relay sellers are owed, what your Lite sellers hold on their balances, and how many sellers' payouts are held, by reason (`frozen`, `new_seller`, `exposure_cap`, `approval_withdrawn`, `insufficient_balance`, `identity_required`).
- `sellers`: the ten first by volume and by net commission in the main `currency`, and the ten riskiest (`elevated` or `high`).

A sale counts in the period it was credited (`credited_at`, else its creation), a part of a shared payment on the day it was settled, and a payout on the day it succeeded (`succeeded_at`). With a sandbox key, `lite_available` is your Lite sellers' sandbox balances and `lite_pending` is 0. A percentage is `null` when there is nothing to compare. Called with your own key, never with `X-Sync`. A sandbox key reads the sandbox.

`as_of`: the period's figures count everything that happened up to this instant (ISO 8601).

## Query parameters

- `period` (string): The period: `7d`, `30d`, `90d` or `12m` (365 days, the chart by month). Defaults to `30d`.

## Responses

- `200`: OK
- `403`: Forbidden
- `422`: Unknown period
- `429`: Too Many Requests
- `503`: Service Unavailable

## Example response (200)

```json
{
  "data": {
    "period": {
      "start": "2026-10-22T00:00:00+00:00",
      "end": "2026-11-20T23:59:59+00:00",
      "previous_start": "2026-09-22T00:00:00+00:00",
      "days": 30
    },
    "sandbox": false,
    "as_of": "2026-11-20T23:58:00+00:00",
    "currency": "XAF",
    "volume": {
      "active_sellers": 4,
      "previous_active_sellers": 1,
      "currencies": [
        {
          "currency": "XAF",
          "amount": 49000,
          "previous_amount": 4000,
          "change_percent": 1125,
          "sales": 5,
          "previous_sales": 1,
          "average": 9800,
          "previous_average": 4000,
          "shared_amount": 6000,
          "shared_percent": 12.24,
          "by_mode": [
            {
              "mode": "direct",
              "amount": 5000,
              "previous_amount": 0,
              "sales": 1
            },
            {
              "mode": "lite",
              "amount": 36000,
              "previous_amount": 4000,
              "sales": 3
            },
            {
              "mode": "relay",
              "amount": 8000,
              "previous_amount": 0,
              "sales": 1
            }
          ]
        }
      ]
    },
    "chart": {
      "currency": "XAF",
      "monthly": false,
      "buckets": [
        {
          "key": "2026-11-19",
          "label": "2026-11-19",
          "current": 6000,
          "previous": 0
        }
      ]
    },
    "commission": [
      {
        "currency": "XAF",
        "taken": 2450,
        "returned": 300,
        "forgone": 70,
        "net": 2150,
        "previous_net": 200,
        "change_percent": 975,
        "take_rate": 4.39,
        "previous_take_rate": 5,
        "by_mode": [
          {
            "mode": "lite",
            "taken": 1800,
            "returned": 300,
            "net": 1500
          }
        ]
      }
    ],
    "risk": {
      "exposure": [
        {
          "mode": "lite",
          "currency": "XAF",
          "exposure": 14000,
          "cap": 5000000,
          "reserve_percentage": 10,
          "used_percent": 0.28,
          "window_days": 90
        }
      ],
      "reserve": [
        {
          "currency": "XAF",
          "held": 4000,
          "next_release_at": "2026-11-30T10:00:00+00:00",
          "card": {
            "held": 1500,
            "sales": 3,
            "next_release_at": "2027-02-18T10:00:00+00:00"
          }
        }
      ],
      "escrow": [
        {
          "currency": "XAF",
          "held": 14250,
          "sales": 1,
          "due_soon": 14250,
          "due_soon_sales": 1,
          "next_release_at": "2026-11-23T10:00:00+00:00"
        }
      ],
      "covers": [
        {
          "currency": "XAF",
          "covered": 3000,
          "covers": 1,
          "recovered": 1000,
          "outstanding": 2000
        }
      ],
      "sellers": {
        "scored": 3,
        "elevated": 1,
        "high": 1,
        "frozen": 1,
        "high_not_frozen": 1
      },
      "disputes": {
        "open": 1,
        "open_amounts": [
          {
            "currency": "XAF",
            "amount": 10000
          }
        ],
        "opened": 1,
        "previous_opened": 0,
        "sales": 4,
        "rate": 25,
        "previous_rate": 0
      }
    },
    "payouts": {
      "currencies": [
        {
          "currency": "XAF",
          "paid": 11000,
          "payouts": 2,
          "previous_paid": 1000,
          "in_flight": 2000,
          "in_flight_payouts": 1,
          "relay_payable": 7600,
          "relay_pending": 0,
          "relay_escrow": 0,
          "lite_available": 12000,
          "lite_pending": 2000
        }
      ],
      "held": [
        {
          "reason": "frozen",
          "sellers": 1
        },
        {
          "reason": "new_seller",
          "sellers": 1
        }
      ]
    },
    "sellers": {
      "currency": "XAF",
      "by_volume": [
        {
          "id": "acc_Gt6yU3nE8rM1kS5vX9bQ",
          "name": "Atelier Ngono",
          "account_type": "lite",
          "connected": true,
          "currency": "XAF",
          "volume": 30000,
          "sales": 2,
          "commission": 1300,
          "risk_score": 80,
          "risk_level": "high",
          "frozen": false
        }
      ],
      "by_commission": [],
      "by_risk": []
    }
  }
}
```
