> ## Documentation Index
> Fetch the complete documentation index at: https://voucherify-rc-lv2-guides.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Get program tiers summary report
>
Documentation in progress
This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.
Returns total tier-movement statistics for the program (all time), optionally
filtered by tier structure and tier.
Results are capped by `limit` (default `100`) and sorted by `order` (default `-id`).
## OpenAPI
````yaml /openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/tiers/summary
openapi: 3.1.0
info:
title: Voucherify Loyalty v2 API
version: 2.0.0
description: >-
Complete OpenAPI specification for the Voucherify Loyalty v2 API.
All endpoints require the LOYALTY_V2 feature flag.
Combined from per-domain specs: programs.yaml, members.yaml,
program-operations.yaml, card-definitions.yaml, earning-rules.yaml,
tier-structures.yaml, benefits.yaml, rewards.yaml, examine.yaml
servers:
- url: '{protocol}://{host}'
variables:
protocol:
default: https
enum:
- https
- http
host:
default: api.voucherify.io
security:
- X-App-Id: []
X-App-Token: []
- bearerAuth: []
tags:
- name: Programs
description: >-
Loyalty program CRUD, lifecycle management, program-scoped resource
assignments (card definitions, earning rules, rewards, tier structures),
member management (create, list, get, update, activate, deactivate,
delete), membership retrieval (member + program + cards with tier
progress, by customer ID, customer source ID, or member ID), card
operations (points adjustment, pending points, expiring points,
transactions), reward purchases, and activity history.
- name: Card Definitions
description: >-
CRUD operations, lifecycle management, and activity history for card
definitions. Card definitions describe the configuration for loyalty
cards, including code generation, points expiration, earning/spending
limits, pending points, refunds, and balance settings.
- name: Earning Rules
description: >-
Manage earning rules that define how customers earn points or receive
incentives based on triggers (events, segments, custom events). Includes
CRUD, lifecycle, and activity history.
- name: Tier Structures
description: >-
CRUD operations, lifecycle management, and activity history for tier
structures. Includes nested tier definitions (create, list, update,
delete) within tier structures. Tier structures define the tiering model
for loyalty programs — how members qualify for and move between tiers.
- name: Benefits
description: >-
Manage benefit definitions (fixed points, proportional points, material,
digital). Includes CRUD, lifecycle transitions, and activity history.
- name: Rewards
description: >-
CRUD, lifecycle operations, and activity history for reward definitions.
Rewards can be material (product/SKU) or digital (discount coupons, gift
vouchers).
- name: Examine
description: >-
Evaluation endpoints that estimate earning opportunities and reward
availability for a customer across their loyalty program memberships,
without side effects.
paths:
/v2/loyalties/programs/{programId}/reports/tiers/summary:
parameters:
- name: programId
in: path
required: true
description: >-
Unique loyalty program identifier (format: `lprg_` followed by
hexadecimal characters).
schema:
type: string
get:
tags:
- Programs
summary: Get program tiers summary report
description: >-
Documentation in progress
This documentation is in progress. The parameters, fields, request and
response bodies, and other data may be subject to change. If you need
more information or you want to share feedback, contact [Voucherify
support](https://www.voucherify.io/contact-support) or your Technical
Account Manager.
Returns total tier-movement statistics for the program (all time),
optionally
filtered by tier structure and tier.
Results are capped by `limit` (default `100`) and sorted by `order`
(default `-id`).
operationId: getProgramTiersSummaryReport
parameters:
- name: limit
in: query
required: false
description: >-
Maximum number of report entries to return. Minimum: 1, maximum:
100. Defaults to 100 when omitted.
schema:
type: integer
minimum: 1
maximum: 100
default: 100
- name: order
in: query
required: false
description: >-
Sort order. A single field or an array of fields. Prefix a field
with `-` for descending order. Defaults to `-id`. Allowed values:
`id`, `-id`.
schema:
oneOf:
- type: string
enum:
- id
- '-id'
- type: array
items:
type: string
enum:
- id
- '-id'
default: '-id'
- name: filters
in: query
required: false
style: deepObject
explode: true
description: >-
Field filters, e.g.
`filters[tier_structure_id][conditions][$is]=lts_...` or
`filters[tier_id][conditions][$is]=lt_...`. Each field accepts a
`conditions` object with condition operators.
schema:
$ref: '#/components/schemas/TiersReportListFilters'
responses:
'200':
description: Program tiers summary report.
content:
application/json:
schema:
$ref: '#/components/schemas/TiersReportSummaryResponse'
examples:
Summary tiers report:
value:
data:
- id: lptrs_128f4a88414c4bed70
tier_structure_id: lts_128f4a88414c4bed69
tier_id: lt_128f4a88414c4bed6a
joins: 1
upgrades: 0
downgrades: 0
lefts: 0
prolongs: 0
object: program_tiers_summary_report
object: report
'400':
description: >-
Validation error - request body or query parameters failed
validation, or the operation is not allowed in the current resource
state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
TiersReportListFilters:
type: object
description: Filters for program tiers reports.
properties:
junction:
description: >-
Logical junction between the field filters. Defaults to AND
behavior.
oneOf:
- type: string
enum:
- AND
- OR
- type: 'null'
tier_structure_id:
description: Filter by tier structure id.
oneOf:
- $ref: '#/components/schemas/TiersReportFilterTierStructureIdConditions'
- type: 'null'
tier_id:
description: Filter by tier id.
oneOf:
- $ref: '#/components/schemas/TiersReportFilterTierIdConditions'
- type: 'null'
additionalProperties: false
TiersReportSummaryResponse:
type: object
description: Program tiers summary report result.
properties:
data:
type: array
description: Report entries, one per tier structure and tier.
items:
$ref: '#/components/schemas/TiersReportSummaryEntry'
object:
type: string
const: report
description: Object type marker. Always `report`.
ErrorResponse:
type: object
description: Standard error response returned by all Loyalty v2 endpoints.
properties:
code:
type: integer
description: HTTP status code of the error.
key:
type: string
description: Machine-readable error key.
message:
type: string
description: Human-readable error message.
details:
type: string
description: Additional details about the error.
request_id:
type: string
description: Unique identifier of the request that produced the error.
resource_id:
type: string
description: Unique identifier of the resource that produced the error.
resource_type:
type: string
description: Type of the resource that produced the error.
TiersReportFilterTierStructureIdConditions:
type: object
description: >-
ID filter conditions for tier structure id. Values must match pattern
`^lts_[a-f0-9]+$`. `$is`/`$is_not` accept a single value (string or
1-element array); `$in`/`$not_in` accept a string or an array of 1-100
values.
properties:
conditions:
type: object
minProperties: 1
additionalProperties: false
properties:
$is:
description: Matches rows whose tier structure id equals the given value.
oneOf:
- type: string
pattern: ^lts_[a-f0-9]+$
- type: array
minItems: 1
maxItems: 1
items:
type: string
pattern: ^lts_[a-f0-9]+$
- type: 'null'
$is_not:
description: >-
Matches rows whose tier structure id does not equal the given
value.
oneOf:
- type: string
pattern: ^lts_[a-f0-9]+$
- type: array
minItems: 1
maxItems: 1
items:
type: string
pattern: ^lts_[a-f0-9]+$
- type: 'null'
$in:
description: Matches rows whose tier structure id is one of the given values.
oneOf:
- type: string
pattern: ^lts_[a-f0-9]+$
- type: array
minItems: 1
maxItems: 100
items:
type: string
pattern: ^lts_[a-f0-9]+$
- type: 'null'
$not_in:
description: >-
Matches rows whose tier structure id is not one of the given
values.
oneOf:
- type: string
pattern: ^lts_[a-f0-9]+$
- type: array
minItems: 1
maxItems: 100
items:
type: string
pattern: ^lts_[a-f0-9]+$
- type: 'null'
required:
- conditions
additionalProperties: false
TiersReportFilterTierIdConditions:
type: object
description: >-
ID filter conditions for tier id. Values must match pattern
`^lt_[a-f0-9]+$`. `$is`/`$is_not` accept a single value (string or
1-element array); `$in`/`$not_in` accept a string or an array of 1-100
values.
properties:
conditions:
type: object
minProperties: 1
additionalProperties: false
properties:
$is:
description: Matches rows whose tier id equals the given value.
oneOf:
- type: string
pattern: ^lt_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lt_[a-f0-9]+$
minItems: 1
maxItems: 1
- type: 'null'
$is_not:
description: Matches rows whose tier id does not equal the given value.
oneOf:
- type: string
pattern: ^lt_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lt_[a-f0-9]+$
minItems: 1
maxItems: 1
- type: 'null'
$in:
description: Matches rows whose tier id is one of the given values.
oneOf:
- type: string
pattern: ^lt_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lt_[a-f0-9]+$
minItems: 1
maxItems: 100
- type: 'null'
$not_in:
description: Matches rows whose tier id is not one of the given values.
oneOf:
- type: string
pattern: ^lt_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lt_[a-f0-9]+$
minItems: 1
maxItems: 100
- type: 'null'
required:
- conditions
additionalProperties: false
TiersReportSummaryEntry:
type: object
description: >-
Total program tier-movement statistics for one tier structure and tier.
All numeric fields default to 0.
properties:
id:
type: string
description: Unique identifier of the summary row.
tier_structure_id:
type: string
pattern: ^lts_[a-f0-9]+$
description: Unique identifier of the tier structure (format `lts_...`).
tier_id:
type: string
pattern: ^lt_[a-f0-9]+$
description: Unique identifier of the tier (format `lt_...`).
joins:
type: number
description: Total number of members who joined this tier.
upgrades:
type: number
description: Total number of upgrades into this tier.
downgrades:
type: number
description: Total number of downgrades into this tier.
lefts:
type: number
description: Total number of members who left this tier.
prolongs:
type: number
description: Total number of tier prolongations.
object:
type: string
const: program_tiers_summary_report
description: Object type marker. Always `program_tiers_summary_report`.
securitySchemes:
X-App-Id:
type: apiKey
name: X-App-Id
in: header
X-App-Token:
type: apiKey
name: X-App-Token
in: header
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````