Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

segment
enum<string>

Restrict the returned rows to one RFM bucket (segment client), e.g. champions.

Available options:
champions,
loyal,
at_risk,
new,
lost
tier
string

Restrict the returned rows to one loyalty-tier label, e.g. Or.

Minimum string length: 1
minMonetaryCents
integer

Restrict the returned rows to customers at or above this lifetime spend, in cents.

Required range: 0 <= x <= 9007199254740991

Response

Whole-base per-segment counts plus the (optionally filtered) rows.

Whole-base per-segment counts plus the (optionally filtered) rows.

referenceDate
string
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
counts
object
required
customers
object[]
required