仪表板查询接口
1. 概述
本页面所有接口均需要临时令牌。请先使用您的 accessKeyId 和 accessKeySecret 获取，详见 登录认证。
访问接口时在设置中将 Value 替换为您的临时令牌。
2. 查询仪表板元信息
接口简介：
接口作用 | 获取指定仪表板的完整元信息，包括所有组件的字段结构（字段ID、名称、数据类型、角色）以及仪表板级参数的定义（参数名称、数据类型、是否支持多值、默认值） |
接口URL | /api/public/analysis/v1/dashboards/{dashboardId}/meta |
请求类型 | GET |
路径参数：
参数 | 类型 | 必填 | 说明 | 示例 |
dashboardId | String | 是 | 仪表板唯一标识 | db_xxx123 |
获取仪表板ID
响应实例：
请求示例 | https://work.jiushuyun.com/decision/api/public/analysis/v1/dashboards/{dashboardId}/meta |
响应成功 | { "code": 200, "data": { "projectId": "agnrdvvdj55dhl5jv7iyq6pr4a", "dashboardId": "agnvg7b6przibjlmz34j4vtusa", "dashboardName": "新建仪表板1", "components": [ { "componentId": "392b911c-f6f0-41bd-9afd-30f7446a43ed", "componentName": "图表-合同事实表 (2)_组件1", "componentType": "crossTable", "fields": [ { "id": "wr6dt8", "name": "合同类型", "dataType": "string", "role": "rowDimension" }, { "id": "iw44qh", "name": "是否已经交货", "dataType": "string", "role": "rowDimension" }, { "id": "3hnvr7", "name": "合同金额", "dataType": "number", "role": "metric" }, { "id": "dnnjmg", "name": "购买数量", "dataType": "number", "role": "metric" }, { "id": "qlmr33", "name": "客户数", "dataType": "number", "role": "metric" } ] }, { "componentId": "agnrdvvhl52lrnarm2x5g2rogy", "componentName": "图表-合同事实表 (2)_组件1", "componentType": "chart", "fields": [ { "id": "o7hhwv", "name": "合同类型", "dataType": "string", "role": "columnDimension" }, { "id": "qxqc5s", "name": "客户数", "dataType": "number", "role": "metric" }, { "id": "xc0tms", "name": "客户数", "dataType": "number", "role": "metric" } ] } ], "parameters": [ { "name": "数值参数", "type": "number", "multiValue": false, "defaultValue": "" } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null} |
截图示例 |
|
响应字段说明
字段路径 | 类型 | 说明 |
data.projectId | String | 所属项目唯一标识 |
data.dashboardId | String | 仪表板唯一标识 |
data.dashboardName | String | 仪表板显示名称 |
data.components | Array | 组件元信息列表 |
data.parameters | Array | 仪表板级参数定义列表 |
3. 查询仪表板组件数据
接口简介：
接口作用 | 查询指定组件的数据内容，支持分页查询和参数传值。返回统一的行优先格式数据 |
接口URL | /api/public/analysis/v1/component/data |
请求类型 | POST |
响应实例：
请求示例 | https://work.jiushuyun.com/decision/api/public/analysis/v1/component/data |
请求body | { "componentId": "392b911c-f6f0-41bd-9afd-30f7446a43ed", "pageRequest": { "pageIndex": 1, "pageSize": 100 }, "parameters": [ { "name": "文本参数", "value":[ "购买合同", "长期协议" ] } ] } |
响应成功 | { "code": 200, "data": { "componentId": "392b911c-f6f0-41bd-9afd-30f7446a43ed", "componentType": "crossTable", "fields": [ { "id": "wr6dt8", "name": "合同类型", "dataType": "string", "role": "rowDimension" }, { "id": "iw44qh", "name": "是否已经交货", "dataType": "string", "role": "rowDimension" }, { "id": "3hnvr7", "name": "合同金额", "dataType": "number", "role": "metric" }, { "id": "dnnjmg", "name": "购买数量", "dataType": "number", "role": "metric" }, { "id": "qlmr33", "name": "客户数", "dataType": "number", "role": "metric" } ], "rows": [ [ "购买合同", "是", 548123010, 445, 285 ], [ "购买合同", "否", 231286000, 172, 113 ] ], "page": { "pageIndex": 1, "pageSize": 100, "hasNext": false } }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null} |
截图示例 |
|
请求参数说明：
参数 | 类型 | 必填 | 说明 |
componentId | String | 是 | 组件唯一标识 |
pageRequest | Object | 是 | 分页请求参数 |
parameters | Array | 否 | 参数传值列表，不传则使用默认值 |
- 分页请求参数（pageRequest）：
参数 | 类型 | 必填 | 说明 | 限制 |
pageIndex | Integer | 是 | 页码，从1开始 | ≥ 1 |
pageSize | Integer | 是 | 每页行数 | 1 ~ 500 |
- 参数传值（parameters）：
参数 | 类型 | 说明 |
name | String | 参数名称，与第 2 节元信息中的参数名对应 |
value | Object | 参数值，支持单值、多值或日期类型，详情见下方参数值类型 |
- 参数值类型（value）：
类型 | 结构 | 说明 | 示例 |
单值参数 | {"value": "华东"} | 对应参数输入框控件 | 文本输入 |
多值参数 | {"values": ["华东", "华北"]} | 对应参数下拉框控件 | 文本多选 |
日期参数 | {"year": 2024, "month": 3, "day": 15} | 对应日期控件 | DATE 类型 |
年月参数 | {"year": 2024, "month": 6} | 对应年月控件 | YEAR_MONTH 类型 |
年季参数 | {"year": 2024, "quarter": 3} | 对应年季控件 | YEAR_QUARTER 类型 |
400-111-0890
在线咨询