Skip to main content
POST
Count a search's matches

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

Request body for counting a search's matches: what to look for, where, among which rows.

The search's own filter half, so the count and the pages can never disagree about what matches. No sort: a count is the same in any order.

query
string
required

The substring to look for; matched case-insensitively.

Required string length: 1 - 256
column_ids
string<uuid>[] | null

Restrict the search to these columns; omit to search every text column.

Maximum array length: 500
where
TableRowsWhereSchema · object | null

The filters the grid is showing, for the same reason.

Response

Successful Response

How many cells a search finds.

count
integer
required

Matching cells. Exact, not an estimate.