Reports
Analytics endpoints for loyalty programme KPIs, earn/redeem trends, member growth, and period-close settlement. All report endpoints are read-only.
Common query parameters
from=2026-01-01 (ISO 8601 start date)
to=2026-05-28 (ISO 8601 end date)
granularity=day (day | week | month)
Endpoints
/tenants/{tenantId}/reports/kpisKPI snapshot — total members, active members, points issued, points redeemed, rewards issued, redemption rate, outstanding liability in cents.
/tenants/{tenantId}/reports/earnTime-series earn data — daily/weekly/monthly points awarded and transaction count. Supports date range filtering.
/tenants/{tenantId}/reports/redeemTime-series redeem data — daily/weekly/monthly points burned and discount amount in cents.
/tenants/{tenantId}/reports/membersMember growth over time — new enrollments, active members, and churn by period.
/tenants/{tenantId}/reports/campaignsPer-campaign performance — transactions matched, points awarded, rewards issued (by type), budget consumed, and redemption count.
/tenants/{tenantId}/settlementOutstanding liability report — total unredeemed points valued in cents at current burn rate. Used for period-close accounting.
Outstanding Liability
The /settlement endpoint returns the total unredeemed points valued at the active burn rate. This is your loyalty programme liability for accounting purposes — the maximum discount members could redeem today. Call it at period close or on demand.