Zum Hauptinhalt springen
GET
Revenue per customer, paged

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 (the customer list is scope-independent; accepted for a uniform query).

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

Analytics segment filter.

customerIds[]
string<uuid>[]

Customer filter.

productIds[]
string<uuid>[]

Product filter.

page
integer
Standard:1

Page, starting at 1.

Erforderlicher Bereich: x >= 1
pageSize
integer
Standard:50

Customers per page.

Erforderlicher Bereich: 1 <= x <= 100

Customer name, customer number or the name of one of the customer's products contains this text (case-insensitive, % and _ are literal).

Maximum string length: 100

Antwort

One page of customers.

One page of the revenue page's customer rows: customers ranked by net revenue in the range (descending; equal amounts by customer id, so the order is stable across pages), each with product sub-rows and a 12-month sparkline ending with the last month of the range.

data
object[]

Customers of this page.

meta
object

page, pageSize and total (customers matching the filters and the search).