Live counters and latest revenue

GET /v1/admin/stats/overview

• Operation ID: getStatsOverview
• Tags: Stats
• Base URL: http://localhost:8787

Live counters (today's signups/activity, totals) plus the most recent daily revenue row per currency.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission stats.read.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: stats.read

Responses

200

Overview.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object

Field	Type	Required	Description
live	object	no	-
live.signups_today	string | number	yes	Integer, bigint-safe: decimal string or number.
live.active_today	string | number	yes	Integer, bigint-safe: decimal string or number.
live.total_users	string | number	yes	Integer, bigint-safe: decimal string or number.
live.active_subscriptions	string | number	yes	Integer, bigint-safe: decimal string or number.
live.credits_consumed_today	string | number	yes	Integer, bigint-safe: decimal string or number.
live.at	string	yes	-
revenue	(object (StatsRevenueRow))[]	yes	-
revenue[].day	string	yes	Date serialised as an ISO timestamp (UTC midnight).
revenue[].currency	string	yes	-
revenue[].mrr	string	yes	Bigint minor units as a decimal string.
revenue[].new_mrr	string	yes	Bigint minor units as a decimal string.
revenue[].churned_mrr	string	yes	Bigint minor units as a decimal string.
revenue[].gross	string	yes	Bigint minor units as a decimal string.
revenue[].refunds	string	yes	Bigint minor units as a decimal string.
revenue[].active_subscriptions	integer	yes	-

Errors

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "stats.read"
  }
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X GET 'http://localhost:8787/v1/admin/stats/overview' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/stats/overview", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();