> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/tiers/summary
openapi: 3.1.0
info:
  title: Voucherify API - Loyalty v2
  version: v2018-08-01
  description: >-
    Voucherify promotion engine REST API. Please see
    https://docs.voucherify.io/docs for more details.
  contact:
    name: Voucherify Team
    url: https://www.voucherify.io/contact-support
    email: support@voucherify.io
  termsOfService: https://www.voucherify.io/legal/subscription-agreement
  license:
    name: MIT
    url: https://github.com/voucherifyio/voucherify-js-sdk/blob/main/LICENSE
servers:
  - url: https://{cluster}.voucherify.io
    description: Base URL
    variables:
      cluster:
        default: api
        enum:
          - api
          - us1.api
          - as1.api
          - download
          - us1.download
          - as1.download
security: []
paths:
  /v2/loyalties/programs/{programId}/reports/tiers/summary:
    parameters:
      - name: programId
        in: path
        required: true
        description: >-
          Identifies the loyalty program. Format: `lprg_` followed by
          hexadecimal characters.
        schema:
          type: string
    get:
      tags:
        - Programs
      summary: List program tiers summary reports
      description: >-
        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.
      operationId: listProgramTiersSummaryReports
      parameters:
        - name: filters
          in: query
          required: false
          style: deepObject
          explode: true
          description: >-
            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_...`.
          schema:
            $ref: '#/components/schemas/TiersReportListFilters'
      responses:
        '200':
          description: Program tiers summary report.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/V2LoyaltiesProgramsReportsTiersSummaryListResponseBody
              examples:
                Summary tiers report:
                  value:
                    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
                Empty tiers summary report:
                  value:
                    data: []
                    object: report
        '400':
          description: Query parameters failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                'Invalid query parameters: `tier_structure_id` is invalid':
                  value:
                    code: 400
                    key: invalid_query_params
                    message: Invalid query params
                    details: >-
                      Property .filters.tier_structure_id.conditions.$is must
                      match pattern "^lts_[a-f0-9]+$"
                    request_id: v-131e4b76ad2e098911
                'Invalid query parameters: `tier_id` is invalid':
                  value:
                    code: 400
                    key: invalid_query_params
                    message: Invalid query params
                    details: >-
                      Property .filters.tier_id.conditions.$is must match
                      pattern "^lt_[a-f0-9]+$"
                    request_id: v-131e4b76ad2e098913
        '404':
          description: Program not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Program not found:
                  value:
                    code: 404
                    key: not_found
                    message: Resource not found
                    details: Cannot find program with id lprg_128f4a88414c4bed69
                    request_id: v-131e4b76ad2e098912
                    resource_id: lprg_128f4a88414c4bed69
                    resource_type: program
                Program id does not match the pattern:
                  value:
                    code: 404
                    key: not_found
                    message: Resource not found
                    details: Cannot find program with id missing
                    request_id: v-131e4b76ad2e098914
                    resource_id: missing
                    resource_type: program
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal server error:
                  value:
                    code: 500
                    key: api_error
                    message: >-
                      Something went wrong. Don't worry, your campaigns are
                      still safe and the Voucherify Team has been notified.
                      Check out our Help Center and forums for help, or head
                      back to home.
      security:
        - X-App-Id: []
          X-App-Token: []
        - bearerAuth: []
components:
  schemas:
    TiersReportListFilters:
      type: object
      description: Filters for program tiers reports.
      properties:
        junction:
          description: >-
            Joins the field filters. Allowed values: `AND`, `OR`. Defaults to
            `AND`.
          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
    V2LoyaltiesProgramsReportsTiersSummaryListResponseBody:
      title: V2 Loyalties Programs Reports Tiers Summary List Response Body
      type: object
      description: >-
        Response body schema for **GET**
        `/v2/loyalties/programs/{programId}/reports/tiers/summary`.
      allOf:
        - $ref: '#/components/schemas/TiersReportSummaryResponse'
    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
                  items:
                    type: string
                    pattern: ^lts_[a-f0-9]+$
                  minItems: 1
                  maxItems: 1
                - 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
                  items:
                    type: string
                    pattern: ^lts_[a-f0-9]+$
                  minItems: 1
                  maxItems: 1
                - 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
                  items:
                    type: string
                    pattern: ^lts_[a-f0-9]+$
                  minItems: 1
                  maxItems: 100
                - 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
                  items:
                    type: string
                    pattern: ^lts_[a-f0-9]+$
                  minItems: 1
                  maxItems: 100
                - 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
    TiersReportSummaryResponse:
      type: object
      description: Program tiers summary report result.
      properties:
        data:
          type: array
          description: >-
            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.
          items:
            $ref: '#/components/schemas/TiersReportSummaryEntry'
        object:
          type: string
          const: report
          description: Object type marker. Always `report`.
      required:
        - data
        - object
    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
          pattern: ^lptrs_[a-f0-9]+$
          description: >-
            Identifies the summary row (format: `lptrs_` followed by hexadecimal
            characters).
        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: Counts expiration-date changes for members who stayed on this tier.
        object:
          type: string
          const: program_tiers_summary_report
          description: Object type marker. Always `program_tiers_summary_report`.
      required:
        - id
        - tier_structure_id
        - tier_id
        - joins
        - upgrades
        - downgrades
        - lefts
        - prolongs
        - object
  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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.