v1

latestOpenAPI 3.0.02026-07-2638801.8 MB
comment

Get record comment counts by query

get/comment/{tableId}/count

Path parameters

tableIdstring required

Query parameters

projectionstring[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

cellFormat'json' | 'text'

Define the return value formate, you can set it to text if you only need simple string value

Define the return value formate, you can set it to text if you only need simple string value

fieldKeyType'id' | 'name' | 'dbFieldName'

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

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

orderBystring

An array of sort objects that specifies how the records should be ordered.

An array of sort objects that specifies how the records should be ordered.

groupBystring

An array of group objects that specifies how the records should be grouped.

An array of group objects that specifies how the records should be grouped.

collapsedGroupIdsstring

An array of group ids that specifies which groups are collapsed

An array of group ids that specifies which groups are collapsed

queryIdstring

When provided, other query parameters will be merged with the saved ones.

Example:qry_xxxxxxxx

When provided, other query parameters will be merged with the saved ones.

string
OR
number

The record count you want to take, maximum is 1000

string
OR
number

The records count you want to skip

Response

Returns the comment counts by query

recordIdstring required
countnumber required