Loyalty reports
Get the key figures of your loyalty programs: members, balance earned and redeemed, reward codes, outstanding balance, daily series and top members. This resource only has one read-only operation.
Endpoint
GET/loyalty-reports
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | number | Yes | ID of your organization (the API key's organization). Without it the request returns 400 organization_id is required. |
program_id | number | No | Only this program. Without it, all programs are combined |
days | number | No | Period in days, from 1 to 365 (default: 30) |
Request
Response
json
Response fields
| Field | Description |
|---|---|
members.total / members.active | All members and members with active status |
members.new_members | Members enrolled in the period |
members.engaged | Members with activity in the period |
members.repeat_members / members.repeat_rate | Members with 2 or more visits, and their percentage |
members.wallet_members / members.wallet_rate | Members who added the card to Apple Wallet or Google Wallet, and their percentage |
movements.earned | Balance earned in the period (purchases, bonuses and referrals) |
movements.redeemed | Balance redeemed or used in the period |
movements.expired | Balance expired in the period |
movements.purchases / movements.member_revenue | Purchases registered on cards in the period and their total amount |
redemptions | Reward codes created in the period: total, used and still pending (issued) |
programs[].outstanding_balance | Balance currently held by members (for cashback and gift cards, the money you owe) |
series | Earned, redeemed and purchases per day |
enrollment_series | New members per day |
enrollment_sources | New members in the period by enrollment_source |
top_members | The 10 members with the highest lifetime_earned |
Balances mix units when several programs of different types are combined; filter by program_id for exact figures.
Report an issue with this documentation
Please log in to report issues with our documentation.