GET
/
plugin
/
chart
/
{pluginInstallId}
/
dashboard
/
{positionId}
/
query
shell
curl --request GET \
  --url 'https://app.teable.ai/api/plugin/chart/%7BpluginInstallId%7D/dashboard/%7BpositionId%7D/query?baseId=SOME_STRING_VALUE&cellFormat=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "rows": [
    {}
  ],
  "columns": [
    {
      "name": "<string>",
      "column": "<string>",
      "type": "aggregation",
      "fieldSource": {
        "id": "<string>",
        "name": "Tags",
        "type": "singleSelect",
        "description": "this is a summary",
        "options": {
          "expression": "countall({values})",
          "timeZone": "<string>",
          "formatting": {
            "date": "<string>",
            "time": "HH:mm",
            "timeZone": "<string>"
          },
          "showAs": {
            "type": "url"
          }
        },
        "aiConfig": {
          "modelKey": "<string>",
          "isAutoFill": true,
          "attachPrompt": "<string>",
          "type": "extraction",
          "sourceFieldId": "<string>"
        },
        "isLookup": true,
        "lookupOptions": {
          "foreignTableId": "<string>",
          "lookupFieldId": "<string>",
          "relationship": "oneOne",
          "fkHostTableName": "<string>",
          "selfKeyName": "<string>",
          "foreignKeyName": "<string>",
          "filter": {},
          "linkFieldId": "<string>"
        },
        "notNull": true,
        "unique": true,
        "isPrimary": true,
        "isComputed": true,
        "isPending": true,
        "hasError": true,
        "cellValueType": "string",
        "isMultipleCellValue": true,
        "dbFieldType": "TEXT",
        "dbFieldName": "<string>",
        "recordRead": true,
        "recordCreate": true
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

pluginInstallId
string
required
positionId
string
required

Query Parameters

baseId
string
required
cellFormat
enum<string>
default:text
Available options:
json,
text

Response

200 - application/json

Returns data about the dashboard install plugin query.

rows
object[]
required
columns
object[]
required