Preview dashboard chart SQL¶

Execute a chart SQL preview, returning query results without saving the chart.

HTTP
POST $CLOUDSIGMA_API_BASE/data-dashboards/{dashboard_id}/preview

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

Set the operation-specific values used in the request:

$DASHBOARD_ID: dashboard_id to use, specifying the target resource via the request path.

Request¶

Replace caller-specific values in the example with actual values.

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/data-dashboards/$DASHBOARD_ID/preview" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "sql_text": "SELECT 1 AS value"
  }'

Parameter reference

Request body

Parameter	Type	Required	Description
`sql_text`	string	Required	The SQL to preview.

Successful response¶

When the request is successful, the data of this operation is returned. Just because the write or run request has been accepted does not mean that the subsequent processing has been completed; please confirm the result based on the return status or subsequent query.

Response example

JSON
{
  "code": 200,
  "data": {"query_id": "query-001", "statement_id": "stmt-001", "status": "completed", "total": 1}
}

Field reference

The response fields are as follows.

Field	Type	Description
`data.query_id`	string	Query ID.
`data.statement_id`	string	Statement ID.
`data.status`	string	Query status.
`data.columns`	array	Result column.
`data.result`	array	Result data.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

Field reference

Field	Type	Description
`code`	integer or string	Error code or status.
`message`	string	Error message.

Last updated on Sep 15, 2026