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.

GET /v2/loyalties/programs/{programId}/reports/points-earnings/summary

List program points-earnings summary reports

cURL

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>'

200

Program points-earnings summary report

{
  "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

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Identifies the loyalty program. Format: lprg_ followed by hexadecimal characters.

Pattern: ^lprg_[a-f0-9]+$

Query Parameters

filters · object | null

Filters rows by earning rule ID and card definition id. Each field takes a conditions object. Omitting filters or setting it to null applies no field filters. Filters for program points-earnings reports.

Show child attributes

Response

200

application/json

Program points-earnings summary report.

Response body schema for GET /v2/loyalties/programs/{programId}/reports/points-earnings/summary.

data · object[] · required

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

object · string · required

Object type marker. Always report.

Allowed value: "report"