Skip to main content
GET
List program rewards summary reports

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required

Path Parameters

programId
string
required

Identifies the loyalty program. Format lprg_[a-f0-9]+.

Pattern: ^lprg_[a-f0-9]+$

Query Parameters

filters
object

Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is]=lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. Filters for program rewards reports.

Response

Program rewards summary report.

Response body schema for GET /v2/loyalties/programs/{programId}/reports/rewards/summary.

data
object[]
required

List of summary rows, one per reward with a recorded purchase attempt, ordered by id descending. Contains at most 100 rows. Empty when no purchase attempts were recorded.

object
string
required

Object type marker. Always report.

Allowed value: "report"