Sign in
Logs

List Logs

Lists log entries of the requested type for the authenticated account.

  • change: audit entries recording each insert, update, or delete event against an account-scoped object, most recent first.
  • session: one entry per Client, Gateway, or Portal session created, most recent first.
  • flow: one entry per network flow reported by Clients and Gateways, most recently started first.
  • api_request: one entry per authenticated REST API request, most recent first.

The begin and end query parameters bound the time window. For change, session, and api_request, entries match when their timestamp falls inside the window; for flow, entries match when the flow was active at any point inside the window, i.e. when [flow_start, flow_end) overlaps it. Both must be RFC 3339 (ISO 8601) timestamps, for example 2026-05-26T00:00:00Z; values with a non-UTC offset are accepted and converted to UTC. When omitted, begin defaults to 90 days before the current time and end defaults to the current time. begin must be less than or equal to end.

Results can be further narrowed by actor_id (every type) or actor_email (change, session, and flow), which matches the email recorded when the entry was created. API requests are made by API clients, which have no email, so actor_email is not supported for api_request.

Use the next_page cursor returned in metadata to fetch the following page of results.

get/logs

Query parameters

typestring required

The log stream to list. One of change, session, flow, or api_request.

limitinteger

Maximum number of Logs to return per page. Defaults to 50. Values greater than 100 are capped to 100, and values less than 1 are raised to 1.

page_cursorstring

Next/Prev page cursor returned by a previous request.

beginstring

Inclusive start of the time window. RFC 3339 timestamp; non-UTC offsets are accepted and converted to UTC. Defaults to 90 days before the current time when omitted.

endstring

Inclusive end of the time window. RFC 3339 timestamp; non-UTC offsets are accepted and converted to UTC. Defaults to the current time when omitted.

actor_idstring

Filter to entries whose actor matches.

actor_emailstring

Filter to entries whose actor email matches the email recorded when the entry was created. Supported for change, session, and flow types.

Response

Logs Response

metadataobject

Pagination metadata

Example response

{
  "data": [
    {
      "after": {
        "name": "Jane Smith"
      },
      "before": {
        "name": "Jane Doe"
      },
      "log_id": "c00060db0c2c8eb400000000",
      "object": "actors",
      "operation": "update",
      "subject": null,
      "timestamp": "2026-05-26T12:34:56.789Z",
      "type": "change"
    }
  ],
  "metadata": {
    "count": 1,
    "limit": 50,
    "next_page": null,
    "prev_page": null
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.