Programs

List program tiers summary reports

Changed on

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/reports/tiers/summary
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Query parameters

junction'AND' | 'OR' nullable

Joins the field filters. Allowed values are AND and OR. Defaults to AND.

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.

Response

Program tiers summary report.

object'report' required

Object type marker. Always report.

Changes

  • v2be14b3318eb3Revision changes
    • info

      api operation id getProgramTiersSummaryReport removed and replaced with listProgramTiersSummaryReports

  • v26a418ac8b7b1Revision changes
    • info

      api operation id listProgramTiersSummaryReports removed and replaced with getProgramTiersSummaryReport