increase-test
GET/events

List events

Lists events recorded for objects in the account. Filter by event category, associated object, or creation time, and use cursor to retrieve subsequent pages of results.

10 parameters
cursorstringoptional
Pagination cursor identifying the position after which to return events. Omit it to start from the first page.
limitintegeroptional
Maximum number of events to return. Must be at least 1 and defaults to 100 when omitted.
Default:100
created_at.afterstringoptional
Return events created after this ISO 8601 timestamp.
created_at.beforestringoptional
Return events created before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return events created at or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return events created at or before this ISO 8601 timestamp.
category.inarray<string>optional
Filter by one or more event categories, encoded as a comma-delimited list.
associated_object_idstringoptional
Filter events to those associated with the object identified by this value.
order_by.directionstringoptional
Sort direction: ascending or descending. Defaults to ascending when omitted.
Allowed:ascendingdescendingDefault:ascending
order_by.fieldstringoptional
Event field to sort by; the supported value is created_at.
Allowed:created_at

3 status codes
200Returns a page containing event objects and a `next_cursor` value for retrieving the next page; the cursor is null when there are no further results.
dataarray<Event>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the service encounters a server-side error.

Error handling

The limit query parameter must be between 1 and 100, and each creation-time filter must be a valid ISO 8601 timestamp. order_by.direction must be ascending or descending, and order_by.field must be created_at.