> ## 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 members summary reports

> Returns all-time member and card totals for the program. The response contains one row when activity was recorded, and an empty `data` array otherwise. `limit` and `order` are not query parameters.

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/members/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/members/summary:
    parameters:
      - name: programId
        in: path
        required: true
        description: >-
          Identifies the loyalty program (`lprg_` followed by hexadecimal
          characters).
        schema:
          type: string
    get:
      tags:
        - Programs
      summary: List program members summary reports
      description: >-
        Returns all-time member and card totals for the program. The response
        contains one row when activity was recorded, and an empty `data` array
        otherwise. `limit` and `order` are not query parameters.


        Returns `400` when query validation fails. Returns `404` when the
        program does not exist.
      operationId: listProgramMembersSummaryReports
      responses:
        '200':
          description: Program members summary report.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/LoyaltiesProgramsReportsMembersSummaryListResponseBody
              examples:
                Summary members report:
                  value:
                    data:
                      - id: lpmrs_12d8b27ab4e0fcb6e1
                        members_joined: 5
                        members_deactivated: 5
                        members_deleted: 2
                        cards: 6
                        object: program_members_summary_report
                    object: report
                Empty members summary report:
                  value:
                    data: []
                    object: report
        '400':
          description: Query parameters failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                'Invalid query parameters: `limit` is not a query parameter':
                  value:
                    code: 400
                    key: invalid_query_params
                    message: Invalid query params
                    details: Query must NOT have additional properties
                    request_id: v-131e4b76ad2e098970
        '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_128f58429fc4bf7b2
                    request_id: v-131e4b76ad2e098972
                    resource_id: lprg_128f58429fc4bf7b2
                    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-131e4b76ad2e098973
                    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:
    LoyaltiesProgramsReportsMembersSummaryListResponseBody:
      type: object
      title: Loyalties Programs Reports Members Summary List Response Body
      description: >-
        Response body schema for **GET**
        `/v2/loyalties/programs/{programId}/reports/members/summary`.
      properties:
        data:
          type: array
          description: >-
            List of summary rows for the program. Contains one row when activity
            was recorded, ordered by `id` descending. Empty when no activity was
            recorded.
          items:
            $ref: '#/components/schemas/MembersReportSummaryEntry'
        object:
          type: string
          const: report
          description: Object type marker. Always `report`.
      required:
        - data
        - object
    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.
    MembersReportSummaryEntry:
      type: object
      description: >-
        All-time member and card changes for the program. Counters that did not
        change are 0.
      properties:
        id:
          type: string
          pattern: ^lpmrs_[a-f0-9]+$
          description: >-
            Identifies the summary row (format: `lpmrs_` followed by hexadecimal
            characters).
        members_joined:
          type: number
          description: Counts members who joined the program.
        members_deactivated:
          type: number
          description: >-
            Counts members deactivated. Decreases by 1 when a member is
            activated again.
        members_deleted:
          type: number
          description: Counts members deleted.
        cards:
          type: number
          description: >-
            Counts cards created. Decreases by 1 when a card is unassigned (e.g.
            when a member is deleted).
        object:
          type: string
          const: program_members_summary_report
          description: Object type marker. Always `program_members_summary_report`.
      required:
        - id
        - members_joined
        - members_deactivated
        - members_deleted
        - cards
        - 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.