---
title: "Get group points"
method: GET
path: "/table/{tableId}/aggregation/group-points"
tags: ["aggregation"]
---

# Get group points

`GET /table/{tableId}/aggregation/group-points`

Returns the distribution and count of records across different group points in the view

## 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.
- `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` union — Search for records that match the specified field and value
  - string[]
  - string[]
  - union[]
    - union
      - string
      - string
      - boolean
- `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` union — When a viewId is specified, configure this to true will ignore the view's filter, sort, etc
  - string
  - boolean

## Response `200`

Group points for the view

- union[], nullable
  - union
    - object
      - `id` string, required
      - `type` 0, required
      - `depth` number, required
      - `value` unknown
      - `isCollapsed` boolean, required
    - object
      - `type` 1, required
      - `count` number, required

---

[API](https://skmtc.net/teable/apis/teable-app.md) · [All operations](https://skmtc.net/teable/apis/teable-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/teable/teable-app/versions/7515f3b33d79/schema)