跳转到主要内容
GET
/
share
/
{shareId}
/
view
/
aggregations
cURL
curl --request GET \
  --url http://127.0.0.1:3000/api/share/{shareId}/view/aggregations \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "type": "grid",
    "createdBy": "<string>",
    "createdTime": "<string>",
    "columnMeta": {},
    "description": "<string>",
    "order": 123,
    "options": {
      "rowHeight": "short",
      "fieldNameDisplayLines": 2,
      "frozenColumnCount": 1,
      "frozenFieldId": "<string>"
    },
    "sort": {
      "sortObjs": [
        {
          "fieldId": "<string>",
          "order": "asc"
        }
      ],
      "manualSort": true
    },
    "filter": {},
    "group": [
      {
        "fieldId": "<string>",
        "order": "asc"
      }
    ],
    "isLocked": true,
    "shareId": "<string>",
    "enableShare": true,
    "shareMeta": {
      "allowCopy": true,
      "includeHiddenField": true,
      "password": "<string>",
      "includeRecords": true,
      "submit": {
        "allow": true,
        "requireLogin": true
      }
    },
    "lastModifiedBy": "<string>",
    "lastModifiedTime": "<string>",
    "pluginId": "<string>"
  }
]

授权

​
Authorization
string
header
必填

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

路径参数

​
shareId
string
必填

查询参数

​
ignoreViewQuery

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

​
filterByTql
string
已弃用
示例:

"{field} = 'Completed' AND {field} > 5"

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

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.

Required array length: 2 elements
示例:
["fldXXXXXXX", "recXXXXXXX"]
​
filterLinkCellSelected

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

Required array length: 2 elements
示例:
["fldXXXXXXX", "recXXXXXXX"]
​
selectedRecordIds
string[]

Filter selected records by record ids

​
groupBy
string

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

​
field
object

响应

200 - application/json

Returns aggregations list of share view.

​
id
string
必填
​
name
string
必填
​
type
enum<string>
必填
可用选项:
grid,
calendar,
kanban,
form,
gallery,
plugin
​
createdBy
string
必填
​
createdTime
string
必填
​
columnMeta
object
必填

A mapping of view IDs to their corresponding column metadata.

​
description
string
​
order
number
​
options
object
​
sort
object
​
filter
object

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.

​
group
object[] | null
​
isLocked
boolean
​
shareId
string
​
enableShare
boolean
​
shareMeta
object
​
lastModifiedBy
string
​
lastModifiedTime
string
​
pluginId
string
Last modified on December 10, 2025