Execute dashboard SQL chart

Executes a SQL chart within a dashboard context asynchronously with inherited filters

POST /api/v2/projects/{projectUuid}/query/dashboard-sql-chart

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "resolvedTimezone": "<string>",
    "usedParametersValues": {},
    "parameterReferences": [
      "<string>"
    ],
    "cacheMetadata": {
      "cacheHit": true,
      "preAggregate": {
        "hit": true,
        "reason": {
          "reason": "no_pre_aggregates_defined"
        },
        "name": "<string>"
      },
      "cacheKey": "<string>",
      "cacheExpiresAt": "2023-11-07T05:31:56Z",
      "cacheUpdatedTime": "2023-11-07T05:31:56Z"
    },
    "queryUuid": "<string>",
    "appliedDashboardFilters": {
      "tableCalculations": [
        {
          "id": "<string>",
          "target": {
            "tableName": "<string>",
            "fieldId": "<string>",
            "isSqlColumn": true
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true,
          "lockedTabUuids": [
            "<string>"
          ],
          "requiredGroupId": "<string>",
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ],
      "metrics": [
        {
          "id": "<string>",
          "target": {
            "tableName": "<string>",
            "fieldId": "<string>",
            "isSqlColumn": true
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true,
          "lockedTabUuids": [
            "<string>"
          ],
          "requiredGroupId": "<string>",
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ],
      "dimensions": [
        {
          "id": "<string>",
          "target": {
            "tableName": "<string>",
            "fieldId": "<string>",
            "isSqlColumn": true
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true,
          "lockedTabUuids": [
            "<string>"
          ],
          "requiredGroupId": "<string>",
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ]
    }
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid · string · required

Body

application/json

Option 1

Option 2

dashboardSorts · object[] · required

Show child attributes

dashboardFilters · object · required

Show child attributes

tileUuid · string · required

dashboardUuid · string · required

savedSqlUuid · string · required

parameters · object

Construct a type with a set of properties K of type T

Show child attributes

usePreAggregateCache · boolean

invalidateCache · boolean

context · enum<string>

Available options: dashboardView, autorefreshedDashboard, exploreView, filterAutocomplete, chartView, chartHistory, sqlChartView, sqlRunner, viewUnderlyingData, alert, scheduledDelivery, csvDownload, gsheets, scheduledGsheetsChart, scheduledGsheetsDashboard, scheduledGsheetsSqlChart, scheduledChart, scheduledDashboard, calculateTotal, calculateSubtotal, embed, ai, mcp.run_metric_query, mcp.run_sql, mcp.search_field_values, api, cli, metricsExplorer, preAggregateMaterialization, dataAppSample

limit · number<double>

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok