Skip to main content
GET
One page of a dataset's records, optionally through a saved view

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.

Path Parameters

project_id
string
required

Project id (UUID) belonging to the caller workspace.

dataset
string
required

Dataset name.

Query Parameters

view
string

Record-view id to shape and sort the rows. The view must belong to this webhook.

limit
integer
default:25

Rows per page (default 25, max 1000).

Required range: 1 <= x <= 1000
offset
integer
default:0

Rows to skip (default 0).

Required range: x >= 0

Response

One page of the dataset's records, newest first unless the view sorts otherwise. Without a view, every row is the record meta columns plus its whole flattened payload and columns is the discovered key set. With a view, each row carries _id plus exactly the view columns (missing keys become null), sorted in SQL by the view sort key. available_columns is the field set of the newest 500 records (at most 300 names, in name order, plus dotted nested paths), the same for any limit, offset or sort; total is the dataset's record count up to 10,000, and total_capped is true when there are more. A view sorted by a payload field sorts only the newest 10,000 records (sort_window); a sort by arrival covers the whole dataset.

dataset
string
required
view
object | null
required

The applied view in list shape (snake_case), or null.

columns
object[]
required
available_columns
string[]
required

Includes the meta columns _id, _received_at and _source. Taken from the newest 500 records, not from this page, so it does not change with limit, offset or view.

rows
object[]
required
count
integer
required
total
integer
required

Records in the dataset, counted up to 10,000 (and, for a view sorted by a payload field, at most sort_window).

total_capped
boolean
required

True when the dataset holds more than 10,000 records, so total is a floor: show it as 10,000+.

sort_window
integer | null
required

Set when the view sorts by a payload field: the sort covers only this many of the newest records. Null for a sort by arrival.

limit
integer
required
offset
integer
required