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.

GET /v2/loyalties/programs/{programId}/reports/tiers/summary

List program tiers summary reports

cURL

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

200

Summary tiers report

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

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.

Query Parameters

filters · object

Filters rows by tier_structure_id and tier_id. Omitting filters or setting it to null applies no field filter. Example: filters[tier_id][conditions][$is]=lt_.... Filters for program tiers reports.

Show child attributes

Response

200

application/json

Program tiers summary report.

Response body schema for GET /v2/loyalties/programs/{programId}/reports/tiers/summary.

data · object[] · required

List of summary rows, one per tier structure and tier with recorded movement, ordered by id descending. Contains at most 100 rows. Empty when no movement was recorded.

Show child attributes

object · string · required

Object type marker. Always report.

Allowed value: "report"