Skip to main content
POST
Read a filtered, sorted, or windowed preview of a CSV table. This route is read-only; table writes replace the whole CSV. Pass filter rules, sort rules, and a window (offset/limit) to shape the returned rows.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id
string
required

Body

application/json
filters
WorkflowTableFilterRule · object[]
search
WorkflowTableSearchRequest · object | null
case_sensitive
boolean
default:false
select
string[]
distinct
WorkflowTableDistinctRequest · object | null
group_by
string[]
aggregations
WorkflowTableAggregationRequest · object[]
sort
WorkflowTableSortRule · object[]
sample
WorkflowTableSampleRequest · object | null
tail
WorkflowTableTailRequest · object | null
count_only
boolean
default:false
include_explain
boolean
default:false
sort_column
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
viewer_mode
string | null
Allowed value: "windowed"
offset
integer
default:0
Required range: x >= 0
limit
integer | null
Required range: 1 <= x <= 500

Response

Successful Response

table_id
string
required
row_count
integer
required
columns
WorkflowTableColumn · object[]
rows
WorkflowTableRow · object[]
filtered_row_count
integer | null
offset
integer
default:0
limit
integer | null
has_more
boolean
default:false
next_cursor
string | null
previous_cursor
string | null
explain
WorkflowTableExplain · object | null