Zum Hauptinhalt springen
GET
Customer base 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.

compareSegmentId
string<uuid>

Second analytics segment for the comparison.

granularity
enum<string>

Cohorts per month (default) or per quarter.

Verfügbare Optionen:
month,
quarter

Antwort

The datasets.

Customer base page: key figures, retention, cohorts, concentration, account movements, churn by reason and segment comparison.

tenantName
string

Name of the organisation.

currency
string

Currency of every amount (ISO-4217).

asOf
string<date-time> | null

Calculation time; null before the first calculation.

months
string[]

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

customers
object

The datasets.

granularity
enum<string>

Cohort granularity.

Verfügbare Optionen:
month,
quarter
segmentComparable
string[]

Fields of segmentMetrics that compare across segments of different size (rates and ARPA).

meta
object

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