curl --request GET \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/tiers/summary \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "lptrs_12d1ada07056ba14da",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b466a0c4bee03",
"joins": 0,
"upgrades": 1,
"downgrades": 0,
"lefts": 0,
"prolongs": 0,
"object": "program_tiers_summary_report"
},
{
"id": "lptrs_12cad1af9bc1616fe5",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b46558c4bedff",
"joins": 0,
"upgrades": 0,
"downgrades": 1,
"lefts": 0,
"prolongs": 0,
"object": "program_tiers_summary_report"
},
{
"id": "lptrs_12cad001d441616ea8",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b46808c4bee07",
"joins": 0,
"upgrades": 4,
"downgrades": 0,
"lefts": 0,
"prolongs": 0,
"object": "program_tiers_summary_report"
},
{
"id": "lptrs_12cac273c0016164ec",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b46400c4bedfb",
"joins": 3,
"upgrades": 0,
"downgrades": 4,
"lefts": 1,
"prolongs": 0,
"object": "program_tiers_summary_report"
}
],
"object": "report"
}List program tiers summary reports
Returns all-time tier-movement totals for the program, one row per tier structure and tier that has recorded movement. Filters rows with filters[tier_structure_id] and filters[tier_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.
curl --request GET \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/tiers/summary \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "lptrs_12d1ada07056ba14da",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b466a0c4bee03",
"joins": 0,
"upgrades": 1,
"downgrades": 0,
"lefts": 0,
"prolongs": 0,
"object": "program_tiers_summary_report"
},
{
"id": "lptrs_12cad1af9bc1616fe5",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b46558c4bedff",
"joins": 0,
"upgrades": 0,
"downgrades": 1,
"lefts": 0,
"prolongs": 0,
"object": "program_tiers_summary_report"
},
{
"id": "lptrs_12cad001d441616ea8",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b46808c4bee07",
"joins": 0,
"upgrades": 4,
"downgrades": 0,
"lefts": 0,
"prolongs": 0,
"object": "program_tiers_summary_report"
},
{
"id": "lptrs_12cac273c0016164ec",
"tier_structure_id": "lts_128f4b460e4c4bedf6",
"tier_id": "lt_128f4b46400c4bedfb",
"joins": 3,
"upgrades": 0,
"downgrades": 4,
"lefts": 1,
"prolongs": 0,
"object": "program_tiers_summary_report"
}
],
"object": "report"
}Authorizations
Path Parameters
Identifies the loyalty program. Format lprg_[a-f0-9]+.
^lprg_[a-f0-9]+$Query Parameters
Filters the results. Pass a deep object, for example filters[tier_id][conditions][$is]=lt_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
Filters for program tiers reports.
Show child attributes
Show child attributes
Response
Program tiers summary report.
Response body schema for GET /v2/loyalties/programs/{programId}/reports/tiers/summary.