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

NameTypeRequiredDescription
organization_idnumberYesID of your organization (the API key's organization). Without it the request returns 400 organization_id is required.
program_idnumberNoOnly this program. Without it, all programs are combined
daysnumberNoPeriod in days, from 1 to 365 (default: 30)

Request

Response

json

Response fields

FieldDescription
members.total / members.activeAll members and members with active status
members.new_membersMembers enrolled in the period
members.engagedMembers with activity in the period
members.repeat_members / members.repeat_rateMembers with 2 or more visits, and their percentage
members.wallet_members / members.wallet_rateMembers who added the card to Apple Wallet or Google Wallet, and their percentage
movements.earnedBalance earned in the period (purchases, bonuses and referrals)
movements.redeemedBalance redeemed or used in the period
movements.expiredBalance expired in the period
movements.purchases / movements.member_revenuePurchases registered on cards in the period and their total amount
redemptionsReward codes created in the period: total, used and still pending (issued)
programs[].outstanding_balanceBalance currently held by members (for cashback and gift cards, the money you owe)
seriesEarned, redeemed and purchases per day
enrollment_seriesNew members per day
enrollment_sourcesNew members in the period by enrollment_source
top_membersThe 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.