Sign in

v1

latestOpenAPI 3.0.02026-07-2638801.8 MB
aggregation

Get record indices for search

Returns the indices and record IDs of records matching the search criteria

get/table/{tableId}/aggregation/search-index

Path parameters

tableIdstring required

Query parameters

viewIdstring

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

Example:viwXXXXXXX

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

string
OR
boolean

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

filterByTqlstring
Example:{field} = 'Completed' AND {field} > 5
filterstring

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.

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.

string[]
OR
string[]
OR

Search for records that match the specified field and value

string[]
OR
string

Filter out the records that can be selected by a given link cell from the relational table. For example, if the specified field is one to many or one to one relationship, recordId for which the field has already been selected will not appear.

string[]
OR
string

Filter out selected records based on this link cell from the relational table. Note that viewId, filter, and orderBy will not take effect in this case because selected records has it own order. Ignoring recordId gets all the selected records for the field

selectedRecordIdsstring[]

Filter selected records by record ids

Filter selected records by record ids

Response

record index with search query

indexnumber required
fieldIdstring required
recordIdstring required