---
title: "Get reward state summary"
method: GET
path: "/v2/rewards/state_summary"
tags: ["Rewards"]
---

# Get reward state summary

`GET /v2/rewards/state_summary`

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

## Query parameters

- `period` 'DAY' | 'MONTH' | 'WEEK'
- `period_count` string
- `end_date` string — [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.
- `success_only` boolean
- `reward_supplier_id` string
- `reward_type` string

## Response `200`

Successful response

- RewardStateSummaryResponse[]
  - `canceled` integer, required — Number of rewards cancelled in this period.
  - `date_from` string, required — [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.
  - `date_to` string, required — [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.
  - `earned` integer, required — Number of rewards earned in this period.
  - `failed` integer, required — Number of rewards that failed fulfilment in this period.
  - `fulfilled` integer, required — Number of rewards fulfilled in this period.
  - `redeemed` integer, required — Number of rewards redeemed in this period.
  - `revoked` integer, required — Number of rewards revoked in this period.
  - `sent` integer, required — Number of rewards sent in this period.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/versions/c16e62e66755/schema)