Zum Hauptinhalt springen
GET
Recurring revenue page datasets

Autorisierungen

Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Abfrageparameter

from
string

First month (YYYY-MM, time zone of the organisation). Default: to minus 11 months.

to
string

Last month (YYYY-MM). Default: the current month. At most 36 months.

currency
string

ISO-4217 code. Default: the default currency.

scope
enum<string>

Movement scope. Default: the organisation setting.

Verfügbare Optionen:
subscription,
invoice_address,
customer,
organisation
segmentId
string<uuid>

Analytics segment: only its customers.

month
string

Month preselected for the bridge (YYYY-MM, within the range). Default: the last month of the range that has ended.

Antwort

The datasets.

Recurring revenue page: key figures, MRR bridge with reasons, committed and known forward MRR, the MRR table and the definitions.

tenantName
string

Name of the organisation.

currency
string

Currency of every amount (ISO-4217).

Beispiel:

"EUR"

asOf
string<date-time> | null

Calculation time; null before the first calculation.

months
string[]

Months of the range (YYYY-MM), ascending.

mrrWire
object

The MRR table (same shape as GET /api/analytics/mrr-financials).

recurring
object

Key figures, bridge months and backlog.

selectedMonth
string | null

Month preselected for the bridge (the month parameter, default the last complete month of the range).

Beispiel:

"2026-08"

mrrCells
object

Snapshot state per snapshotted table row, aligned with months: the copied MRR rows (mrr_bop, mrr_eop, new, expansion, contraction, lost, resurrecting) and the rows derived from them with the table's formulas (arr_eop; revenue_churn_rate and mom_growth as rates at scale 6; their restatement is always null). Rows not listed keep their current values and are named in meta.notSnapshotted. Empty object when the range has no snapshot or a segment is applied (snapshots are organisation-wide).

definitions
object

Definitions catalogue.

meta
object

Calculation time, scope, currency, findings, filters not applied.