Skip to Content

get_platform_kpis

Platform-wide KPIs for a date range (default last 30 days, max 400; UTC): organizations (total, active, suspended, new), paying organizations, users, products, subscription counts by status, monthly recurring revenue per currency (minor units), active and lost installations, the top 10 organizations by active installations now, and the top 10 by net growth in active installations over the range (activations and reactivations add one, a deactivation or a removal from active subtracts one — the same rule as the panel’s Products growth column). For this month, pass from = the first of the month. Costs 3 rate-limit units.

  • Server: Platform server
  • Scope: platform.overview:read
  • Read-only: yes

Input

{ "properties": { "from": { "description": "YYYY-MM-DD (UTC)", "type": "string" }, "to": { "description": "YYYY-MM-DD (UTC), inclusive", "type": "string" } }, "type": "object" }

Output (structuredContent)

{ "properties": { "as_of": { "type": "string" } }, "type": "object", "required": [ "as_of" ] }