Searches for loyalty events.
Open in API Reference
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. For more information, see Pagination.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The maximum number of results to include in the response. The last page might contain fewer events. The default is 30 events.
A set of one or more predefined query filters to apply when searching for loyalty events. The endpoint performs a logical AND to evaluate multiple filters and performs a logical OR on arrays that specifies multiple field values.
The query filter criteria.
Filter events by date time range. For each range, the start time is inclusive and the end time is exclusive.
The created_at date time range used to filter the result.
created_at
A datetime value in RFC 3339 format indicating when the time range ends.
A datetime value in RFC 3339 format indicating when the time range starts.
Filter events by location.
The location IDs for loyalty events to query. If multiple values are specified, the endpoint uses a logical OR to combine them.
Filter events by loyalty account.
The ID of the loyalty account associated with loyalty events.
Filter events by the order associated with the event.
Filter events by event type.
The loyalty event types used to filter the result. If multiple values are specified, the endpoint uses a logical OR to combine them.
// No response received yet.