curl --request GET \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/points-earnings/summary \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "lppes_132df39de951666c5b",
"earning_rule_id": "lern_128f48ee44cc4bec34",
"earning_item_id": "lernei_132df28ca59f245b8f",
"card_definition_id": "lcdef_128f4a88414c4bed69",
"success_count": 1,
"points": 0,
"pending_points": 150,
"object": "program_points_earnings_summary_report"
},
{
"id": "lppes_12a92be5da077a3460",
"earning_rule_id": "lern_128f48ee44cc4bec34",
"earning_item_id": "lernei_128f48ee3fcc4bec33",
"card_definition_id": "lcdef_128f4a88414c4bed69",
"success_count": 39,
"points": 0,
"pending_points": 2251295,
"object": "program_points_earnings_summary_report"
},
{
"id": "lppes_12a92be5b1077a345a",
"earning_rule_id": "lern_128f5822398c4bf78f",
"earning_item_id": "lernei_128f582238cc4bf78e",
"card_definition_id": "lcdef_128f49963c0c4becb7",
"success_count": 40,
"points": 0,
"pending_points": 400,
"object": "program_points_earnings_summary_report"
},
{
"id": "lppes_12a92be5b0c77a3459",
"earning_rule_id": "lern_128f5834b30c4bf7a3",
"earning_item_id": "lernei_128f5834b20c4bf7a2",
"card_definition_id": "lcdef_128f495f720c4bec8c",
"success_count": 40,
"points": 0,
"pending_points": 400,
"object": "program_points_earnings_summary_report"
}
],
"object": "report"
}List program points-earnings summary reports
Returns total points-earnings statistics for the program (all time), optionally filtered by earning rule or card definition. Each entry sums earning operations for one earning rule, earning item, and card definition. 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/points-earnings/summary \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "lppes_132df39de951666c5b",
"earning_rule_id": "lern_128f48ee44cc4bec34",
"earning_item_id": "lernei_132df28ca59f245b8f",
"card_definition_id": "lcdef_128f4a88414c4bed69",
"success_count": 1,
"points": 0,
"pending_points": 150,
"object": "program_points_earnings_summary_report"
},
{
"id": "lppes_12a92be5da077a3460",
"earning_rule_id": "lern_128f48ee44cc4bec34",
"earning_item_id": "lernei_128f48ee3fcc4bec33",
"card_definition_id": "lcdef_128f4a88414c4bed69",
"success_count": 39,
"points": 0,
"pending_points": 2251295,
"object": "program_points_earnings_summary_report"
},
{
"id": "lppes_12a92be5b1077a345a",
"earning_rule_id": "lern_128f5822398c4bf78f",
"earning_item_id": "lernei_128f582238cc4bf78e",
"card_definition_id": "lcdef_128f49963c0c4becb7",
"success_count": 40,
"points": 0,
"pending_points": 400,
"object": "program_points_earnings_summary_report"
},
{
"id": "lppes_12a92be5b0c77a3459",
"earning_rule_id": "lern_128f5834b30c4bf7a3",
"earning_item_id": "lernei_128f5834b20c4bf7a2",
"card_definition_id": "lcdef_128f495f720c4bec8c",
"success_count": 40,
"points": 0,
"pending_points": 400,
"object": "program_points_earnings_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[earning_rule_id][conditions][$is]=lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
Filters for program points-earnings reports.
Show child attributes
Show child attributes
Response
Program points-earnings summary report.
Response body schema for GET /v2/loyalties/programs/{programId}/reports/points-earnings/summary.
List of summary rows, one per earning rule, earning item, and card definition with recorded activity, ordered by id descending. Contains at most 100 rows. Empty when no activity was recorded.
Show child attributes
Show child attributes
Object type marker. Always report.
"report"