Preview dashboard chart SQL¶

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

POST https://moi.matrixorigin.cn/newmoi/data-dashboards/{dashboard_id}/preview

Preparation before calling¶

Prepare a personal access token and target workspace ID that has access to the target workspace.

The example below uses:

$AI_STUDIO_API_KEY: The actual personal access token, passed through the X-API-Key Header.
$WORKSPACE_ID: Target workspace ID, passed through X-Workspace-ID Header.
$DASHBOARD_ID: dashboard_id to use, specifying the target resource via the request path.

Request body¶

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

sql_textstringRequired: The SQL to preview.

Request example

curl -X POST "https://moi.matrixorigin.cn/newmoi/data-dashboards/$DASHBOARD_ID/preview" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "sql_text": "SELECT 1 AS value"
  }'

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.

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

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¶

codeinteger or string: Error code or status.
messagestring: Error message.

Error response example

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

Last updated on Sep 3, 2026