List program earning-rules summary reports

Returns total earning-rule evaluation statistics for the program (all time), optionally filtered by earning rule. Includes success and failure counts with a failures breakdown. Each entry counts eligibility checks for one earning rule. 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/earning-rules/summary

List program earning-rules summary reports

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/reports/earning-rules/summary \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

Program earning-rules summary report

{
  "data": [
    {
      "id": "lpers_12f8c3cb8fdaa184cd",
      "earning_rule_id": "lern_128f57ec40cc4bf762",
      "success_count": 3,
      "failures_count": 0,
      "failures_breakdown": {
        "COOLDOWN": 0,
        "FREQUENCY": 0
      },
      "object": "program_earning_rules_summary_report"
    },
    {
      "id": "lpers_12a92be41e477a33d8",
      "earning_rule_id": "lern_128f5834b30c4bf7a3",
      "success_count": 40,
      "failures_count": 0,
      "failures_breakdown": {
        "COOLDOWN": 0,
        "FREQUENCY": 0
      },
      "object": "program_earning_rules_summary_report"
    },
    {
      "id": "lpers_12a92be41b077a33d1",
      "earning_rule_id": "lern_128f5822398c4bf78f",
      "success_count": 40,
      "failures_count": 0,
      "failures_breakdown": {
        "COOLDOWN": 0,
        "FREQUENCY": 0
      },
      "object": "program_earning_rules_summary_report"
    },
    {
      "id": "lpers_12a92be418877a33ca",
      "earning_rule_id": "lern_128f48ee44cc4bec34",
      "success_count": 40,
      "failures_count": 0,
      "failures_breakdown": {
        "COOLDOWN": 0,
        "FREQUENCY": 0
      },
      "object": "program_earning_rules_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

Filters rows by field. Each field accepts a conditions object with condition operators. Filters for program earning-rules reports.

Show child attributes

Response

200

application/json

Program earning-rules summary report.

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

data · object[] · required

List of summary rows, one per earning rule 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"