List events

GET/events

Lists the public events of the current account. Internal event types are never returned.

Results are paginated by cursor and sorted by ID in ascending order unless sort specifies otherwise. The collection can be filtered by event type, resource type, resource ID, and occurrence time.

Newly recorded events become visible after a short delay of a few seconds, so the most recent events may not appear immediately.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
type[]?array<string>

Only events of these types. Repeat the parameter to match any of several types.

resource_type?string

Only events about resources of this type.

resource_id?string

Only events about the resource with this public ID.

occurred_after?string

Only items that occurred after this date and time (ISO 8601).

Formatdate-time
occurred_before?string

Only items that occurred before this date and time (ISO 8601).

Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/events"
{  "data": [    {      "correlation_id": "string",      "data": {},      "id": "string",      "object": "event",      "occurred_at": "2019-08-24T14:15:22Z",      "request_id": "string",      "resource": {        "id": "string",        "object": "string"      },      "type": "string",      "version": 0    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}