仪表板接口 - FineBI Cloud

仪表板接口

1. 概述

仪表板接口用于获取 FineBI Cloud 仪表板的元信息和组件数据，支持分页查询与参数传值。

本文所有接口均需要临时令牌。请先使用 accessKeyId 和 accessKeySecret 获取临时令牌，详情请参见：登录认证。访问接口时，在请求头中设置 Authorization，值为获取到的临时令牌。

2. 查询仪表板元信息

获取指定仪表板的完整元信息，包括组件字段结构，以及仪表板级参数的名称、数据类型、是否支持多值和默认值。

接口信息	说明
接口路径	/api/public/analysis/v1/dashboards/{dashboardId}/meta {dashboardId}为仪表板的ID，可通过「分析表接口第 3 节」接口获取
请求方式	GET

响应实例：

请求示例	https://bi.finecloud.com/decision/api/public/analysis/v1/dashboards/agqoy4xqmjywhag2glyhxn7n2e/meta
响应成功	{ "code": 200, "data": { "projectId": "agpljh2uh5zzhf5nrvuhwxivwa", "dashboardId": "agqoy4xqmjywhag2glyhxn7n2e", "dashboardName": "商品销售年度趋势", "components": [ { "componentId": "1640150b-6e44-4537-99a4-1da95efe42ba", "componentName": "合同明细", "componentType": "crossTable", "fields": [ { "id": "3gudtd", "name": "合同签约时间", "dataType": "date", "role": "rowDimension" }, { "id": "vboxec", "name": "合同类型", "dataType": "string", "role": "rowDimension" }, { "id": "ppfxpr", "name": "总金额", "dataType": "number", "role": "metric" } ] }, { "componentId": "2556a934-4466-40a4-9722-b093abef707d", "componentName": "图表1-DEMO_CONTRACT_Sheet1", "componentType": "chart", "fields": [ { "id": "lpxkwe", "name": "合同类型", "dataType": "string", "role": "dimension" }, { "id": "619rl7", "name": "总金额", "dataType": "number", "role": "dimension" } ] }, { "componentId": "2f3da62e-9b3c-408c-ae3b-b50cb08f533e", "componentName": "图表-DEMO_CONTRACT_Sheet1", "componentType": "chart", "fields": [ { "id": "tzrmcg", "name": "合同签约时间", "dataType": "date", "role": "dimension" }, { "id": "girx9a", "name": "总金额", "dataType": "number", "role": "dimension" }, { "id": "2ypkfw", "name": "总金额", "dataType": "number", "role": "dimension" } ] } ], "parameters": [] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示例

响应字段说明

字段路径	类型	说明
data.projectId	String	所属项目唯一标识
data.dashboardId	String	仪表板唯一标识
data.dashboardName	String	仪表板显示名称
data.components	Array	组件元信息列表，包含组件 ID、名称、类型及字段结构
data.parameters	Array	仪表板级参数定义列表，包含参数名称、类型、多值支持和默认值

3. 查询仪表板组件数据

查询指定组件的数据，支持分页查询和参数传值，返回行优先格式的数据。

接口信息	说明
接口路径	/api/public/analysis/v1/component/data
请求方式	POST

请求参数

参数	类型	说明
componentId	String	组件唯一标识，可通过第 2 节获取
pageRequest	Object	分页请求参数，包含以下字段： pageIndex：页码，从 1 开始 pageSize：每页行数，支持1～500
parameters	Array	参数传值列表，不传则使用默认值，每项包含以下字段： name：参数名称，与第 2 节元信息中的参数名对应 value：参数值，支持单值、多值或日期类型

参数值类型如下。

类型	结构示例	说明
单值参数	{"value":"华东"}	对应参数输入框控件
多值参数	{"values":["华东","华北"]}	对应参数下拉框控件
日期参数	{"year":2024,"month":3,"day":15}	对应日期控件，DATE 类型
年月参数	{"year":2024,"month":6}	对应年月控件，YEAR_MONTH 类型
年季参数	{"year":2024,"quarter":3}	对应年季控件，YEAR_QUARTER 类型

响应实例：

请求示例	https://bi.finecloud.com/decision/api/public/analysis/v1/component/data
请求Body	{ "componentId":"2556a934-4466-40a4-9722-b093abef707d", "pageRequest":{ "pageIndex":1, "pageSize":100 }, "parameters":[ { "name":"合同类型", "value":["购买合同","长期协议"] } ] }
响应成功	{ "code": 200, "data": { "componentId": "2556a934-4466-40a4-9722-b093abef707d", "componentType": "chart", "fields": [ { "id": "lpxkwe", "name": "合同类型", "dataType": "string", "role": "dimension" }, { "id": "619rl7", "name": "总金额", "dataType": "number", "role": "dimension" } ], "rows": [ [ "长期协议订单", 68381420 ], [ "购买合同", 779409010 ], [ "服务协议", 11665800 ], [ "长期协议", 17675000 ] ], "page": { "pageIndex": 1, "pageSize": 100, "hasNext": false } }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示例