GET/audit-logs/export/chunk

Download an organization's audit log records for a time range as a file, for archival, compliance, or offline analysis. For interactive browsing, use GET /audit-logs.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

start*string

Lower bound (inclusive) for the audit record timestamp.

Formatdate-time
end*string

Upper bound (exclusive) for the audit record timestamp.

Formatdate-time
auth_strategy?string

Filter by authentication strategy.

service?string

Filter by service name.

method?string

Filter by HTTP method.

exclude_method?array<string>

Filter out results by HTTP method.

Itemsitems <= 10
search?string

Free-text search over path, user ID, email, client IP, and status.

search_user_id?array<string>

Additional user IDs to OR into free-text search.

Itemsitems <= 100
cursor?string

Opaque cursor from X-Next-Cursor for the next chunk of older records.

limit?integer

Maximum number of records to return in this chunk.

Range1 <= value <= 50000
Default50000
format?string

Encoding for the returned chunk.

Default"jsonl.gz"

Value in

  • "jsonl"
  • "jsonl.gz"

Response Body

application/octet-stream

application/json

application/json

application/json

curl -X GET "https://example.com/audit-logs/export/chunk?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
"string"