Skip to main content
POST
Search records (events)

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

project_id
string
required

Project id (UUID) belonging to the caller workspace.

Body

application/json

All filters optional and ANDed. An unparseable body is treated as {}.

dataset
string
Pattern: ^[A-Za-z][A-Za-z0-9_]{0,62}$
q
string

Case-insensitive for common accented letters, as well as ASCII (full Unicode case folding is not supported, for example ß): a substring match against the raw payload JSON.

since
string

ISO timestamp; matches received_at >= since.

until
string

ISO timestamp; matches received_at <= until.

limit
integer
default:25
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0

Response

One page of records, newest first, with the total the page came out of. payload is truncated to 2000 characters.

entity
string
required
Allowed value: "events"
count
integer
required
total
integer
required
limit
integer
required
offset
integer
required
results
object[]
required