# Account overview

The figures on the dashboard's overview, for the mode of the key: the last 30 days against the 30 before, where customers drop out, and what is waiting on a person. They are worked out at most every five minutes, and sooner when anything in the account changes.

## The overview object

| Field | Type | Description |
| --- | --- | --- |
| `object` | "overview" | The kind of object. |
| `period.from, period.to` | string | The 30 days the figures cover, today included, as YYYY-MM-DD. |
| `currency` | string | The currency the amounts are in: the one most charges were paid in over the period, otherwise the account's default. |
| `volume, sent_volume` | string | What was paid in that currency over the period, and what of it reached your wallets once its payout confirmed. |
| `volume_change_percent` | number\|null | How volume compares with the 30 days before, in percent. Null when nothing was paid then. |
| `paid_charges, conversion_rate_percent` | integer, number\|null | How many charges were paid, and what share of the charges that ended over the period ended paid. |
| `pending_charges, active_payment_links, open_invoices, overdue_invoices` | integer | What is open right now. |
| `funnel` | object | Where the period's charges ended: started, paid, waiting, abandoned and incomplete, and the same per coin under assets. |
| `attention` | object | What waits on a person: underpaid_charges and late_payments to accept or refund (id, asset, amount, received_amount, at most five each), payouts_waiting_for_address per coin, and failing_webhook_endpoints, the active endpoints with a failed delivery in the last 7 days. |
| `assets` | array | The coins charges were paid in over the period: asset, paid_charges and share_percent. |
| `top_payment_links` | array | The four payment links with the most paid charges over the period: id, title and paid_charges. |
| `setup` | object | Whether the account has a payout_address, a payment_link, a paid_charge, a webhook_endpoint and a public_profile in this mode, to tell what is left to set up. |
| `daily` | array | One entry per day of the period: date, volume, sent_volume and paid_charges. |

## Endpoints

- GET `/v1/overview` The overview of the key's mode, with meta.mode. Needs overview:read.

## Example: read the overview

```bash
curl 'https://api.velirapay.com/v1/overview' \
  --fail-with-body --silent --show-error --max-time 30 \
  -H "Authorization: Bearer ${VELIRAPAY_API_KEY:?Set VELIRAPAY_API_KEY}" \
  -H 'Accept: application/json'
```

**Response**

```json
{
  "data": {
    "object": "overview",
    "period": { "from": "2026-10-08", "to": "2026-11-06" },
    "currency": "USD",
    "volume": "4280.00",
    "volume_change_percent": 12.5,
    "sent_volume": "4011.62",
    "paid_charges": 37,
    "conversion_rate_percent": 82.22,
    "pending_charges": 3,
    "funnel": { "started": 45, "paid": 37, "waiting": 3, "abandoned": 4, "incomplete": 1, "assets": [ … ] },
    "attention": {
      "underpaid_charges": [ { "id": "2t4bcuqkpkoy", "asset": "BTC", "amount": "0.00151", "received_amount": "0.0015" } ],
      "late_payments": [],
      "payouts_waiting_for_address": [],
      "failing_webhook_endpoints": 0
    },
    "daily": [ { "date": "2026-10-08", "volume": "120.00", "sent_volume": "116.40", "paid_charges": 1 }, … ],
    …
  },
  "meta": { "mode": "live" }
}
```

What each coin has been paid out and is still owed is under payouts. [See the payout summary](https://velirapay.com/docs/payouts)