List program rewards summary reports
curl --request GET \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/rewards/summary \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "lprrs_132d80d588916617aa",
"reward_id": "lrew_1294cebb458e4904a0",
"success_count": 3,
"failures_count": 1,
"failures_breakdown": {
"FREQUENCY": 1
},
"object": "program_rewards_summary_report"
}
],
"object": "report"
}
List program rewards summary reports
Returns all-time reward-purchase totals for the program, one row per reward with a recorded purchase attempt. Filters rows with filters[reward_id]. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array.
Returns 400 when query validation fails. Returns 404 when the program does not exist.
GET
/
v2
/
loyalties
/
programs
/
{programId}
/
reports
/
rewards
/
summary
List program rewards summary reports
curl --request GET \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/rewards/summary \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "lprrs_132d80d588916617aa",
"reward_id": "lrew_1294cebb458e4904a0",
"success_count": 3,
"failures_count": 1,
"failures_breakdown": {
"FREQUENCY": 1
},
"object": "program_rewards_summary_report"
}
],
"object": "report"
}
Authorizations
X-App-Id & X-App-TokenbearerAuth
Path Parameters
Identifies the loyalty program (lprg_ followed by hexadecimal characters).
Query Parameters
Filters rows by field conditions, e.g. filters[reward_id][conditions][$is]=lrew_....
Filters for program rewards reports.
Show child attributes
Show child attributes
Response
Program rewards summary report.
Response body schema for GET /v2/loyalties/programs/{programId}/reports/rewards/summary.