GET
/
table
/
{tableId}
/
aggregation
/
group-points
shell
curl --request GET \
  --url 'https://app.teable.ai/api/table/%7BtableId%7D/aggregation/group-points?viewId=viwXXXXXXX&filter=SOME_STRING_VALUE&search=SOME_ARRAY_VALUE&groupBy=SOME_STRING_VALUE&collapsedGroupIds=SOME_STRING_VALUE&ignoreViewQuery=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
[
  {
    "id": "<string>",
    "type": 0,
    "depth": 1,
    "value": "<any>",
    "isCollapsed": true
  }
]

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

​
viewId
string

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

Example:

"viwXXXXXXX"

​
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.

​
search

Search for records that match the specified field and value

Required array length: 1 element
​
groupBy
string

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

​
collapsedGroupIds
string

An array of group ids that specifies which groups are collapsed

​
ignoreViewQuery

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

Response

200 - application/json
object[] | null

Group points for the view

​
id
string
required
​
type
enum<number>
required
Available options:
0
​
depth
number
required
Required range: 0 <= x <= 2
​
isCollapsed
boolean
required
​
value
any