查看数据看板详情

读取指定数据看板及其数据源和图表配置。

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

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID，分别通过 X-API-Key 和 X-Workspace-ID 请求头传递。从查看数据看板列表的列表中选择所需数据看板的 ID，写入请求路径中的 $DASHBOARD_ID。

路径参数

调用示例

curl -X GET "https://moi.matrixorigin.cn/newmoi/data-dashboards/$DASHBOARD_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

参数	类型	是否必填	说明
dashboard_id	string	是	数据看板 ID。

成功响应

查看成功时返回数据看板、数据源、图表和告警信息。

响应示例

{
  "code": 0,
  "data": {
    "ID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
    "Name": "销售概览",
    "Description": "按日查看销售数据",
    "CreatedByRoleID": "role-001",
    "CreatedAt": "2026-08-21T07:00:00Z",
    "UpdatedAt": "2026-08-21T07:00:00Z",
    "sources": [
      {
        "ID": "source-001",
        "DashboardID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
        "TableID": 1001,
        "DatabaseName": "analytics",
        "TableName": "daily_sales",
        "CreatedAt": "2026-08-21T07:00:00Z"
      }
    ],
    "charts": [],
    "alerts": [],
    "active_alert_count": 0
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 0。
data	object	数据看板详情。
sources	array	数据源列表。
charts	array	图表列表；详情响应中返回。
alerts	array	告警记录列表。

数据看板

下面表格展开响应示例中的 data 对象；每一行是该对象的一个字段。

字段	类型	说明
ID	string	数据看板 ID。
Name	string	数据看板名称。
Description	string	数据看板说明。
CreatedByRoleID	string	创建数据看板时使用的角色 ID。
CreatedAt	string	创建时间。
UpdatedAt	string	更新时间。
active_alert_count	integer	当前处于告警状态的图表数量。

数据源

下面表格展开 data 中的 sources 列表；每一行是列表中一个数据源关联记录的字段。

字段	类型	说明
ID	string	数据源关联记录 ID。
DashboardID	string	数据看板 ID。
TableID	integer	数据表 ID。
DatabaseName	string	数据库名称。
TableName	string	数据表名称。
CreatedAt	string	数据源关联记录的创建时间。

图表

下面表格展开 data 中的 charts 列表；每一行是列表中一个图表的字段。

字段	类型	说明
ID	string	图表 ID；用于图表的更新、删除、运行和结果读取请求。

错误响应

响应示例

{
  "code": 3,
  "message": "not found",
  "details": {
    "domain": "moi-core.catalog.data_dashboard",
    "reason": "DATA_DASHBOARD_NOT_FOUND"
  }
}

字段说明

字段	类型	说明
code	integer 或 string	错误代码或状态码。
message	string	错误信息。

最后更新于 2026 年 9 月 3 日