What’s available
| Endpoint family | What it tells you |
|---|---|
GET /v2/merchants/{id}/metrics | High-level merchant-wide KPIs |
GET /v2/merchants/{id}/metrics/chart | Time-series data for the merchant dashboard |
GET /v2/reports | Per-program reports (transactions, customers, gift card activity) |
Common patterns
Daily snapshot
Schedule a daily job that pulls metrics and pipes them into your BI tool:Time-series for a custom dashboard
Best practices
- Cache aggressively. Reports are eventually consistent — minute-level freshness is more than enough for most dashboards.
- Page through large reports. Use the
limitandcursorparameters where supported. - For real-time, prefer webhooks. Polling reports is the wrong tool when you need event-level reaction. See Webhooks.
