Get reward state summary
Returns aggregate state counts for rewards on this client (e.g. earned, fulfilled, cancelled).
Authorizations
Query Parameters
Time period for grouping (e.g. DAY, WEEK, MONTH).
DAY, MONTH, WEEK Number of periods to include in the summary.
End of the date range for the summary. RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
^\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])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
When true, include only rewards that were successfully fulfilled.
Filter by one or more reward supplier ids (repeat the parameter for multiple values).
Filter by one or more reward types (repeat the parameter for multiple values).
Response
Successful response
Number of rewards cancelled in this period.
RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
^\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])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
^\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])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
Number of rewards earned in this period.
Number of rewards that failed fulfilment in this period.
Number of rewards fulfilled in this period.
Number of rewards redeemed in this period.
Number of rewards revoked in this period.
Number of rewards sent in this period.
