Developers
Requests2

List requests

GET/requests

Lists the authenticated API requests made on the current account, most recent first by default.

Results are paginated with a cursor. The collection can be filtered by outcome, action code, affected resource (resource_type and resource_id), and time range (occurred_after and occurred_before).

Authorization

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

  • "occurred_at"
  • "-occurred_at"
outcome[]?array<string>

Only requests with these outcomes. Repeat the parameter to match any of several outcomes.

action_code?string

Only requests with this action code.

resource_type?string

Only requests that affected resources of this type.

resource_id?string

Only requests that affected 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/requests"
{  "data": [    {      "action": "string",      "actor": {        "admin_id": "string"      },      "client_request_id": "string",      "credential": {        "id": "string"      },      "diff": {},      "event_id": "string",      "http_status": 0,      "id": "string",      "item_key": "string",      "kind": "request",      "method": "string",      "object": "request_log",      "occurred_at": "2019-08-24T14:15:22Z",      "operation_id": "string",      "origin": {        "client": {          "install_id": "string",          "name": "string",          "version": "string"        },        "ip": "string",        "ip_source": "trusted_proxy",        "user_agent": "string"      },      "outcome": "succeeded",      "path": "string",      "recorded_at": "2019-08-24T14:15:22Z",      "request_id": "string",      "resource": {        "id": "string",        "object": "string"      }    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Requests2

Requests in API v3: list requests, retrieve a request.

Retrieve a request GET

Retrieves a logged API request together with the audit entries it produced. `data.request` describes the request itself, and `data.effects` lists the resulting audit entries in ascending order of `occurred_at`. Requests that do not exist or are not accessible with the current credentials return `404 Not Found` with the `not_found` error code.