Get aggregated statistics

GET

table

{tableId}

aggregation

curl --request GET \
  --url https://app.teable.io/api/table/%7BtableId%7D/aggregation \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

[
  {
    "aggregations": [
      {
        "fieldId": "<string>",
        "total": {
          "value": "<string>",
          "aggFunc": "count"
        },
        "group": {}
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

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

Path Parameters

tableId

string

required

Response

200 - application/json

Returns aggregations list.

aggregations

object[]

Get total row countReturns the total number of rows in a view based on applied filters and criteria

curl --request GET \
  --url https://app.teable.io/api/table/%7BtableId%7D/aggregation \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

[
  {
    "aggregations": [
      {
        "fieldId": "<string>",
        "total": {
          "value": "<string>",
          "aggFunc": "count"
        },
        "group": {}
      }
    ]
  }
]

Quick Start

API List

Get aggregated statistics

Authorizations

Path Parameters

Response