查看数据看板列表¶

按条件分页查看当前工作区可见的数据看板。

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

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。首次读取不需要分页令牌；下一页使用上一次响应返回的令牌。

请求体¶

将示例中的调用者专属值替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/data-dashboards/list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "search": "销售",
    "page_size": 20
  }'

参数说明

参数	类型	是否必填	说明
`search`	string	否	按名称或说明筛选。
`page_size`	integer	否	每页返回数量。
`page_token`	string	否	下一页令牌。

成功响应¶

查看成功时返回分页结果。

响应示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "ID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
        "Name": "销售概览",
        "Description": "按日查看销售数据",
        "CreatedByRoleID": "role-001",
        "CreatedAt": "2026-08-21T07:00:00Z",
        "UpdatedAt": "2026-08-21T07:00:00Z"
      }
    ],
    "total": 21,
    "has_more": true,
    "next_page_token": "eyJvZmZzZXQiOjIwfQ"
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 0。
data	object	分页结果。
items	array	数据看板列表。

数据看板

下面表格展开响应示例中 data 下的 items 列表；每一行是列表中一个数据看板的字段。

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

分页信息

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

字段	类型	说明
total	integer	匹配的数据看板总数。
has_more	boolean	是否还有下一页。
next_page_token	string	下一页令牌；没有下一页时为空字符串。

错误响应¶

响应示例

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

字段说明

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

最后更新于 2026 年 9 月 11 日