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

# Get reward state summary

> Returns aggregate state counts for rewards on this client (e.g. earned, fulfilled, cancelled).



## OpenAPI

````yaml /api-reference/integration-server-to-extole.json get /v2/rewards/state_summary
openapi: 3.0.1
info:
  description: >-
    Server-to-Extole integration endpoints: event submission, person lookup,
    zone rendering, token management, and reward retrieval for backend services
    authenticating with client credentials.
  title: Integration API - Server to Extole
  version: '1.0'
servers:
  - description: Production
    url: https://api.extole.io
security:
  - HEADER: []
  - QUERY: []
  - COOKIE: []
tags:
  - name: Authentication
  - name: Batch Jobs
  - name: Events
  - name: Files
  - name: Persons
  - name: Reward Suppliers
  - name: Rewards
  - name: SFTP Servers
  - name: Zone Rendering
paths:
  /v2/rewards/state_summary:
    get:
      tags:
        - Rewards
      summary: Get reward state summary
      description: >-
        Returns aggregate state counts for rewards on this client (e.g. earned,
        fulfilled, cancelled).
      operationId: getRewardStateSummary
      parameters:
        - description: Time period for grouping (e.g. `DAY`, `WEEK`, `MONTH`).
          in: query
          name: period
          schema:
            enum:
              - DAY
              - MONTH
              - WEEK
            type: string
        - description: Number of periods to include in the summary.
          in: query
          name: period_count
          schema:
            type: string
        - description: End of the date range for the summary.
          in: query
          name: end_date
          schema:
            $ref: '#/components/schemas/ZonedDateTime'
        - description: When true, include only rewards that were successfully fulfilled.
          in: query
          name: success_only
          schema:
            type: boolean
        - description: >-
            Filter by one or more reward supplier ids (repeat the parameter for
            multiple values).
          in: query
          name: reward_supplier_id
          schema:
            type: string
        - description: >-
            Filter by one or more reward types (repeat the parameter for
            multiple values).
          in: query
          name: reward_type
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/RewardStateSummaryResponse'
                type: array
          description: Successful response
        '400':
          content:
            application/json:
              examples:
                binding_error:
                  $ref: '#/components/examples/binding_error'
                invalid_json:
                  $ref: '#/components/examples/invalid_json'
                invalid_parameter:
                  $ref: '#/components/examples/invalid_parameter'
                missing_request_body:
                  $ref: '#/components/examples/missing_request_body'
                period_count_invalid:
                  $ref: '#/components/examples/period_count_invalid'
                period_not_supported:
                  $ref: '#/components/examples/period_not_supported'
                reward_state_invalid:
                  $ref: '#/components/examples/reward_state_invalid'
                reward_type_not_supported:
                  $ref: '#/components/examples/reward_type_not_supported'
                time_interval_invalid:
                  $ref: '#/components/examples/time_interval_invalid'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              examples:
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unauthorized
        '402':
          content:
            application/json:
              examples:
                payment_required:
                  $ref: '#/components/examples/payment_required'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Payment Required
        '403':
          content:
            application/json:
              examples:
                access_denied:
                  $ref: '#/components/examples/access_denied'
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
                missing_access_token:
                  $ref: '#/components/examples/missing_access_token'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Forbidden
        '415':
          content:
            application/json:
              examples:
                unsupported_media_type:
                  $ref: '#/components/examples/unsupported_media_type'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unsupported Media Type
        '429':
          content:
            application/json:
              examples:
                too_many_requests:
                  $ref: '#/components/examples/too_many_requests'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Too Many Requests
components:
  schemas:
    ZonedDateTime:
      description: >-
        [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or
        [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4)
        date-time with a numeric [UTC
        offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and
        an optional [IANA
        time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4)
        suffix in square brackets. Precision up to milliseconds.
      example: '2025-10-24T02:00:00-07:00'
      pattern: >-
        ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
      type: string
    RewardStateSummaryResponse:
      properties:
        canceled:
          description: Number of rewards cancelled in this period.
          format: int32
          type: integer
        date_from:
          $ref: '#/components/schemas/ZonedDateTime'
        date_to:
          $ref: '#/components/schemas/ZonedDateTime'
        earned:
          description: Number of rewards earned in this period.
          format: int32
          type: integer
        failed:
          description: Number of rewards that failed fulfilment in this period.
          format: int32
          type: integer
        fulfilled:
          description: Number of rewards fulfilled in this period.
          format: int32
          type: integer
        redeemed:
          description: Number of rewards redeemed in this period.
          format: int32
          type: integer
        revoked:
          description: Number of rewards revoked in this period.
          format: int32
          type: integer
        sent:
          description: Number of rewards sent in this period.
          format: int32
          type: integer
      required:
        - canceled
        - date_from
        - date_to
        - earned
        - failed
        - fulfilled
        - redeemed
        - revoked
        - sent
      type: object
    RestExceptionResponse:
      description: Represents the API error response
      properties:
        code:
          description: Specific error code for this error type, documented per endpoint
          type: string
        http_status_code:
          description: >-
            HTTP status code that was returned with this error, useful if client
            get response code
          format: int32
          type: integer
        message:
          description: User readable English description of the error
          type: string
        parameters:
          additionalProperties:
            description: >-
              Attributes related to the error, varies be error code, documented
              per endpoint
            type: object
          description: >-
            Attributes related to the error, varies be error code, documented
            per endpoint
          type: object
        unique_id:
          description: >-
            Unique id associated with this error, useful for discussions with
            Extole
          type: string
      required:
        - code
        - http_status_code
        - message
        - parameters
        - unique_id
      type: object
  examples:
    binding_error:
      summary: binding_error
      value:
        code: binding_error
        http_status_code: 400
        message: Argument is not of the expected type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_json:
      summary: invalid_json
      value:
        code: invalid_json
        http_status_code: 400
        message: JSON is invalid
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_parameter:
      summary: invalid_parameter
      value:
        code: invalid_parameter
        http_status_code: 400
        message: Parameter is invalid.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_request_body:
      summary: missing_request_body
      value:
        code: missing_request_body
        http_status_code: 400
        message: Missing request body
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    period_count_invalid:
      summary: period_count_invalid
      value:
        code: period_count_invalid
        http_status_code: 400
        message: Invalid period count
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    period_not_supported:
      summary: period_not_supported
      value:
        code: period_not_supported
        http_status_code: 400
        message: Period not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_state_invalid:
      summary: reward_state_invalid
      value:
        code: reward_state_invalid
        http_status_code: 400
        message: Specified reward state type is not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_type_not_supported:
      summary: reward_type_not_supported
      value:
        code: reward_type_not_supported
        http_status_code: 400
        message: Reward type not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    time_interval_invalid:
      summary: time_interval_invalid
      value:
        code: time_interval_invalid
        http_status_code: 400
        message: Time interval is invalid or not ISO-8601 explicit form
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    method_unauthorized:
      summary: method_unauthorized
      value:
        code: method_unauthorized
        http_status_code: 401
        message: Unauthorized access to this endpoint
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    payment_required:
      summary: payment_required
      value:
        code: payment_required
        http_status_code: 402
        message: The access_token provided is associated with an unpaid account.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    access_denied:
      summary: access_denied
      value:
        code: access_denied
        http_status_code: 403
        message: >-
          The access_token provided is not permitted to access the specified
          resource.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_access_token:
      summary: missing_access_token
      value:
        code: missing_access_token
        http_status_code: 403
        message: No access_token was provided with this request.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    unsupported_media_type:
      summary: unsupported_media_type
      value:
        code: unsupported_media_type
        http_status_code: 415
        message: Request had an unsupported or no media type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    too_many_requests:
      summary: too_many_requests
      value:
        code: too_many_requests
        http_status_code: 429
        message: >-
          The server is unable to process your request at the moment, please
          retry later.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
  securitySchemes:
    HEADER:
      in: header
      name: Authorization
      type: apiKey
      x-bearer-format: bearer
    QUERY:
      in: query
      name: access_token
      type: apiKey
    COOKIE:
      in: cookie
      name: extole_token
      type: apiKey

````