GET
/
events
This endpoint requires your private API key.

Query Parameters

​
event
string

The event name to filter by.

​
uuid
string

The UUID to filter by.

​
userId
string

The user ID to filter by.

​
groupId
string

The group ID to filter by.

​
anonymousId
string

The anonymous ID to filter by.

​
instanceId
string

The instance ID to filter by.

​
startDate
string

The start date to filter by.

​
endDate
string

The end date to filter by.

​
limit
number

The limit of records to return.

​
offset
number

The offset of records to return.

​
orderByField
string

The field to order by.

​
orderByDirection
enum<string>

The direction to order by.

Available options:
ASC,
DESC

Response

200 - application/json
​
limit
number | null
required

The limit of the pagination.

​
offset
number | null
required

The offset of the pagination.

​
total
number | null
required

The total number of results. If null, the total is unknown.

​
results
object[]
required

The events found based on the query.

Was this page helpful?

Create EventsGet Webhooks