Retrieve a time-filtered list of every event for all customers

get

https://api.staging.antavo.com/customers/-/events

This endpoint returns all events for all customers that match the specified datetime timestamp query.
The returned object contains the total number of matching events and an array of every matching event.

The datetime filter accepts the following operators and can be combined to generate a time window:

gt - greater than
lt - less than
gte - greater than or equal
lte - less than or equal

The timestamp filter must be in ISODate format. Example: timestamp.gt=2023-01-05,timestamp.gt=2023-01-05T13:28:55 or timestamp.gt=2023-01-05T13:28:55.233+0000.

Note: The timezone offset optional parameter (e.g., +0000) must be URL-encoded.

Query Params

timestamp.gt

string

Filter events with timestamp greater than the specified value.

timestamp.lt

string

Filter events with timestamp less than the specified value.

timestamp.gte

string

Filter events with timestamp greater than or equal to the specified value.

timestamp.lte

string

Filter events with timestamp less than or equal to the specified value.

limit

integer

Defaults to 100

Limits the number of events returned in one response. Other values are accessible by pagination made accessible via the offset.

offset

integer

Defaults to 0

Offsets the starting number of events to return. Used for pagination in conjunction with the limit query.

order

string

Used to sort and order the results in ascending or descending order. The value can be asc for sorting the results by _id in an ascending order, or desc for sorting the results by date and _id in a descending order.

Response

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Time-filtered events