GET
/
share
/
{shareId}
/
view
/
aggregations
curl --request GET \
  --url 'https://app.teable.cn/api/share/%7BshareId%7D/view/aggregations?ignoreViewQuery=SOME_STRING_VALUE&filterByTql=%7Bfield%7D+%3D+%27Completed%27+AND+%7Bfield%7D+%3E+5&filter=SOME_STRING_VALUE&search=SOME_ARRAY_VALUE&filterLinkCellCandidate=fldXXXXXXX&filterLinkCellCandidate=recXXXXXXX&filterLinkCellSelected=fldXXXXXXX&filterLinkCellSelected=recXXXXXXX&selectedRecordIds=SOME_ARRAY_VALUE&groupBy=SOME_STRING_VALUE&field=SOME_OBJECT_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
[
  {
    "id": "<string>",
    "name": "<string>",
    "type": "grid",
    "description": "<string>",
    "order": 123,
    "options": {
      "rowHeight": "short",
      "fieldNameDisplayLines": 2,
      "frozenColumnCount": 1
    },
    "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
      }
    },
    "createdBy": "<string>",
    "lastModifiedBy": "<string>",
    "createdTime": "<string>",
    "lastModifiedTime": "<string>",
    "columnMeta": {},
    "pluginId": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
shareId
string
required

Query Parameters

​
ignoreViewQuery

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

​
filterByTql
string
deprecated
Example:

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

​
filter
string

A filter object used to filter results. It allows complex query conditions based on fields, operators, and values.

​
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
Example:
["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
Example:
["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

Response

200 - application/json

Returns aggregations list of share view.

The response is of type object[].