Zum Hauptinhalt springen
GET
Export the customer base page as XLSX

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

XLSX file download.

The response is of type file.