GET
/
table
/
{tableId}
/
aggregation
/
search-count
shell
curl --request GET \
  --url 'https://app.teable.ai/api/table/%7BtableId%7D/aggregation/search-count?filter=SOME_STRING_VALUE&viewId=viwXXXXXXX&search=SOME_ARRAY_VALUE&ignoreViewQuery=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "count": 123
}

Authorizations

Authorization
string
header
required

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

Path Parameters

tableId
string
required

Query Parameters

filter
string

A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters.

viewId
string

Set the view you want to fetch, default is first view. result will filter and sort by view options.

Example:

"viwXXXXXXX"

Search for records that match the specified field and value

Required array length: 1 element
ignoreViewQuery

When a viewId is specified, configure this to true will ignore the view's filter, sort, etc

Response

200 - application/json

Search count with query

count
number
required