Get loyalty KPIs

View as Markdown

Program-aware headline analytics — the same numbers the merchant’s Perkss dashboard shows: member and visit totals, top members, and the program-specific emission/redemption counters. The response shape follows the active program type: switch on the programType discriminator.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Program-aware stat-card payload — switch on programType.

cashbackobject
OR
stampsobject

Errors

401
Unauthorized Error
429
Too Many Requests Error
503
Service Unavailable Error