创建数据看板¶

创建数据看板并关联数据源。

POST https://api.moi.matrixorigin.cn/v5/data-dashboards

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的数据源表 ID 替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/data-dashboards" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "销售概览",
    "description": "按日查看销售数据",
    "sources": [
      {"table_id": 1001}
    ]
  }'

参数说明

参数	类型	是否必填	说明
`name`	string	是	数据看板名称。
`description`	string	是	数据看板说明。
`sources`	array of object	是	数据源列表。
`sources`	array of object	是	数据源列表。
`table_id`	integer	是	每个数据源中的表 ID。

成功响应¶

创建成功后，记录返回的数据看板 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"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	integer	成功时为 `0`。
`data`	object	新建的数据看板。

数据看板

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

字段	类型	说明
`ID`	string	数据看板 ID。
`Name`	string	数据看板名称。
`Description`	string	数据看板说明。
`CreatedByRoleID`	string	创建时使用的角色 ID。
`CreatedAt`	string	创建时间。
`UpdatedAt`	string	更新时间。

错误响应¶

响应示例

{
  "code": 2,
  "message": "invalid argument",
  "details": {
    "domain": "moi-core.catalog.data_dashboard",
    "reason": "DATA_DASHBOARD_INVALID_REQUEST"
  }
}

字段说明

字段	类型	说明
`code`	integer	错误代码。
`message`	string	错误信息。
`details.domain`	string	错误所属的服务域。
`details.reason`	string	错误原因代码。

后续操作¶

记录响应中数据看板的 ID，再创建看板图表。

最后更新于 2026 年 9 月 11 日