Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Rewards

Get reward state summary

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

get/v2/rewards/state_summary

Query parameters

period'DAY' | 'MONTH' | 'WEEK'

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

period_countstring

Number of periods to include in the summary.

end_datestring

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.

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

End of the date range for the summary.

success_onlyboolean

When true, include only rewards that were successfully fulfilled.

reward_supplier_idstring

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

reward_typestring

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

Response

Successful response

canceledinteger required

Number of rewards cancelled in this period.

date_fromstring 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.

date_tostring 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.

earnedinteger required

Number of rewards earned in this period.

failedinteger required

Number of rewards that failed fulfilment in this period.

fulfilledinteger required

Number of rewards fulfilled in this period.

redeemedinteger required

Number of rewards redeemed in this period.

revokedinteger required

Number of rewards revoked in this period.

sentinteger required

Number of rewards sent in this period.

Example response

[
  {
    "date_from": "2025-10-24T02:00:00-07:00",
    "date_to": "2025-10-24T02:00:00-07:00"
  }
]