Skip to main content
GET
get_artifact_rows

Authorizations

X-API-Key
string
header
required

Path Parameters

workspace_id
string<uuid>
required

Workspace identifier.

Query Parameters

path
string
required

Exact workspace-relative path of a live source, derivative, or query-result artifact.

Required string length: 1 - 1024
Pattern: ^[^/]
start_row
integer
default:0

File row number of the first row in the page, 0-based.

Required range: x >= 0
limit
integer
default:50

Rows per page.

Required range: 1 <= x <= 200
ranges
string | null

Ascending, non-overlapping inclusive row ranges to read instead of a contiguous window, e.g. '3-3,17-19'. Replaces start_row/limit; the ranges may cover at most as many rows as the page limit allows.

Maximum string length: 8400
Pattern: ^\d+-\d+(,\d+-\d+)*$

Response

Successful Response

One page of rows from a tabular workspace artifact.

Rows are returned in file order, so start_row is both the request offset and the file row number of rows[0] — callers can label each row with its source row number without another lookup.

columns
QueryTableColumn · object[]
required
limit
integer
required
path
string
required
rows
Rows · object[]
required
start_row
integer
required
total_rows
integer
required