Data dashboard¶
Use the Data Dashboard API to create dashboards and dashboard charts, run charts, and read or download results.
Choose a task¶
Task |
Page |
Description |
|---|---|---|
Inspect data dashboard list |
Query the data dashboard visible in the current workspace by paging according to conditions. |
|
Inspect data dashboard details |
Read the specified data dashboard and its data source and chart configuration. |
|
Add data dashboard |
Create data dashboards and connect data sources. |
|
Edit data dashboard |
Update the name, description, and data source of the specified data dashboard. |
|
Remove data dashboard |
Delete the specified data dashboard and its configuration. |
|
Add dashboard chart |
Create a chart in the specified data dashboard. |
|
Edit dashboard chart |
Update the query, display and refresh configuration of the specified chart. |
|
Remove dashboard chart |
Delete the chart in the specified data dashboard. |
|
Preview chart SQL results |
Execute a chart SQL preview, returning query results without saving the chart. |
|
Draft chart SQL from a question |
Generate and validate a read-only SQL draft without executing SQL or creating a chart. |
|
Run dashboard chart |
Submit a chart run; acceptance does not indicate that results are ready. |
|
Inspect dashboard chart result |
Read the latest results of the chart; the latest snapshot before the specified time point can be read through |
|
Download dashboard chart result |
Download a CSV file of the specified chart results. |
|
Refresh all charts in a dashboard |
Requests to refresh all charts in the specified data dashboard. |