Skip to main content
GET
List program rewards daily 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

start_date
string<date>
required

Sets the inclusive start of the report date range. Format YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string<date>
required

Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.

Pattern: ^\d{4}-\d{2}-\d{2}$
resolution
enum<string>
required

Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.

Available options:
day,
week,
month,
quarter
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 daily report.

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

data
object[]
required

List of report entries, one per reward and aggregation period with recorded purchases, ordered by date ascending. Empty when no purchases were recorded in the range.

object
string
required

Object type marker. Always report.

Allowed value: "report"