Skip to main content
GET
Get reward state summary

Authorizations

Authorization
string
header
required

Query Parameters

period
enum<string>

Time period for grouping (e.g. DAY, WEEK, MONTH).

Available options:
DAY,
MONTH,
WEEK
period_count
string

Number of periods to include in the summary.

end_date
string

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.

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])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

success_only
boolean

When true, include only rewards that were successfully fulfilled.

reward_supplier_id
string

Filter by one or more reward supplier ids (repeat the parameter for multiple values).

reward_type
string

Filter by one or more reward types (repeat the parameter for multiple values).

Response

Successful response

canceled
integer<int32>
required

Number of rewards cancelled in this period.

date_from
string
required

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.

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])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

date_to
string
required

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.

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])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

earned
integer<int32>
required

Number of rewards earned in this period.

failed
integer<int32>
required

Number of rewards that failed fulfilment in this period.

fulfilled
integer<int32>
required

Number of rewards fulfilled in this period.

redeemed
integer<int32>
required

Number of rewards redeemed in this period.

revoked
integer<int32>
required

Number of rewards revoked in this period.

sent
integer<int32>
required

Number of rewards sent in this period.