table-rows

Query a listing's row IDs

Get the record IDs a listing selects, in order, carrying NO cell data.

Takes the same sorts, where and row_status vocabulary as the rows query and answers only the membership-and-order half of it. Pages are correspondingly large (the default is 10,000 IDs) because a page of IDs is a fraction of the size of a page of rows.

Pair it with the rows query's record_ids mode: fetch an ordering once, then hydrate contents a window at a time. A client holding both can re-sort or re-filter by refetching only the ordering, and reuse every cell it already has.

A POST for the same reason the rows query is one: a filter list has no honest query-string encoding.

post/tables/{table_id}/rows/ids/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/tables/{table_id}/rows/ids/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required

Request body

cursorstring nullable

Opaque cursor from a previous page's next_cursor.

limitinteger

Maximum record IDs per page. Far higher than the rows query's limit because a page of IDs carries no cells.

offsetinteger nullable

Start the listing this many rows in. Mutually exclusive with cursor.

row_status'errored' | 'fully_computed'

A row-level state, derived from its cells rather than stored.

ERRORED is "any cell of this row failed to compute"; FULLY_COMPUTED is its exact complement, so the two partition the table. Serves the built-in smart views, which are questions about computation rather than about values. The ordinary filter vocabulary cannot express either.

Response

Successful Response

has_moreboolean required
limitinteger required
next_cursorstring nullable required

Cursor for the next page; None when this is the last page.

record_idsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.