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 (lprg_ followed by hexadecimal characters).

Query Parameters

start_date
string<date>
required

Sets the inclusive start of the report date range, in YYYY-MM-DD format.

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

Sets the inclusive end of the report date range, in YYYY-MM-DD format. Requires start_date to be before end_date.

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

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

Available options:
day,
week,
month,
quarter
filters
object

Filters rows by field conditions, e.g. filters[reward_id][conditions][$is]=lrew_.... 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"