v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB

Events

List Events

This endpoint enables you to fetch a list of events that have been created by the system. You can use query parameters to filter the results by the created_at time using created_at.lt, created_at.gt, etc. and you can limit the number of events returned.

Use page_cursor from the previous response to paginate through results. Use order to control sort direction (ASC or DESC by created_at). Events returned will be ordered by created_at in ascending order by default.

get/events

Query parameters

created_at.ltstring date-time

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.ltestring date-time

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.eqstring date-time

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtestring date-time

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtstring date-time

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

limitinteger

Number of results to return. Defaults to 100 if no limit is provided.

typestring

Retrieve all (default) or optionally filter by event type.

is_testboolean

Filter for test events (true) or real events (false). Defaults to false (real events only).

order'DESC' | 'ASC'

Sort order for results by created_at. Defaults to ASC (oldest first).

page_cursorstring

Cursor from a previous response to fetch the next page.

Response

Success

next_page_cursorstring

Cursor to pass in the next request to fetch the next page. Empty when no more results.