Skip to main content
The Network Health KPI endpoints power the SuperAdmin dashboard. Every endpoint returns aggregated, network-wide metrics — no per-tenant scoping. All require operator-level access.
All admin endpoints below require:
  • JWT with role = SUPER_ADMIN
  • IpAllowlistGuard — caller IP must be in the operator allowlist
  • GeoBlockGuard — caller geo must be permitted
Calls that miss any of the three return 403.

Common query parameters (KPI endpoints)

Date range is capped to 365 days. Requests outside the cap return 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., became KYB_VERIFIED).

Response — 200 OK

GET /admin/dashboard/confirmed-orders

Orders that transitioned to CONFIRMED (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 to limit (default 10, max 100).

Query parameters

Response — 200 OK

Example

GET /admin/affiliate/top-products

Top products by affiliate-driven units sold.

Query parameters

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