All admin endpoints below require:
- JWT with
role = SUPER_ADMIN IpAllowlistGuard— caller IP must be in the operator allowlistGeoBlockGuard— caller geo must be permitted
403.Common query parameters (KPI endpoints)
| Param | Type | Required | Description |
|---|---|---|---|
startDate | ISO-8601 date (YYYY-MM-DD) | Yes | Inclusive lower bound |
endDate | ISO-8601 date (YYYY-MM-DD) | Yes | Inclusive upper bound |
400.
GET /admin/dashboard/registered-users
Total new platform-user signups (merchant + customer) within the window.Response — 200 OK
Example
GET /admin/dashboard/verified-shops
Shops that completed KYB within the window (i.e., becameKYB_VERIFIED).
Response — 200 OK
GET /admin/dashboard/confirmed-orders
Orders that transitioned toCONFIRMED (payment captured + saga complete) within the window.
Response — 200 OK
GET /admin/dashboard/created-products
Products created (any merchant) within the window.Response — 200 OK
GET /admin/dashboard/gmv
Network GMV (gross merchandise value) for confirmed orders, expressed in USD-equivalent using the same FX snapshot table that the unified-transaction projection uses.Response — 200 OK
GET /admin/dashboard/refund-rate
Refund rate =refundedAmount / confirmedAmount for the window, computed PSP-by-PSP and
network-wide.
Response — 200 OK
GET /admin/affiliate/top-merchants
Top merchants by affiliate-driven GMV, limited tolimit (default 10, max 100).
Query parameters
| Param | Type | Required | Description |
|---|---|---|---|
limit | integer (1-100) | No | Max rows; defaults to 10 |
Response — 200 OK
Example
GET /admin/affiliate/top-products
Top products by affiliate-driven units sold.Query parameters
| Param | Type | Required | Description |
|---|---|---|---|
limit | integer (1-100) | No | Max rows; defaults to 10 |
Response — 200 OK
GET /admin/operations/services
Live operational status of the ECS services that make up the platform — fetched from the ECS describe-services API and cached for 60s.Response — 200 OK
When to use
The first thing to hit when an operator says “is the platform up?” — confirms desired vs running task count and current task-definition revision per service.GET /admin/operations/sentry-summary
Rolling 24-hour Sentry summary, scoped to the org’s main projects (apiv3, 3rdp, checkout, shop-builder).Response — 200 OK
GET /admin/operations/deploys/latest
The most recent successful deploy per service, joined with the GitHub PR / commit that shipped it. Useful when triaging a regression — “what changed in the last 6 hours?”Response — 200 OK
Related
- PSP health — per-PSP breaker + probe state.
- Aggregate merchant provisioner — bulk merchant onboarding.
- Bonum admin — Bonum-specific reconcile + config.
- Telr admin — Telr-specific reconcile.