分析表接口 - FineBI Cloud

分析表接口

1. 概述

读取分析表接口用于查询 FineBI Cloud 中的项目和表，并导出指定分析表的数据。

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

响应实例：

请求示例	https://bi.finecloud.com/decision/api/v1/folders
响应成功	{ "success": true, "code": "200", "message": "success", "data": [ { "id": "agqowmaqtbz6hlvgepbfqma4em", "name": "仓库管理" }, { "id": "agqowl47enzjfji4xzqebctfwq", "name": "办公用品申请" }, { "id": "agpljh2uh5zzhf5nrvuhwxivwa", "name": "出入库管理" } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示例

返回的 id 为项目 ID，用于第 3 节查询。

接口信息	说明
接口作用	获取指定项目下所有表、仪表板、故事板的名称与 ID 对应关系
接口路径	/api/v1/{folderId}/tables {folderId}：第 2 节获取的项目 ID
请求方式	POST

响应示例：

请求示例	https://bi.finecloud.com/decision/api/v1/agpljh2uh5zzhf5nrvuhwxivwa/tables
响应成功	{ "success": true, "code": "200", "message": "success", "data": [ { "id": "agqoy4xqmjywhag2glyhxn7n2e", "name": "商品销售年度趋势" }, { "id": "agprxlvmen6upgfj2syzfvjele", "name": "供应商合同" }, { "id": "agqowsviir4hhf3yltvew53gsu", "name": "合同事实表" } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示例

接口信息	说明
接口作用	导出分析表数据
接口路径	/api/v2/export
请求方式	POST
请求参数	{ "tableId":"{tableId}", "format":"excel" } {tableId}为目标分析表ID，可通过第 3 节获取 format：支持 csv 和 excel；不传时默认为 csv
注意事项	仅支持导出分析表，不支持数据源表、仪表板和故事板通过此接口导出不消耗导出次数

响应实例：

请求示例	https://bi.finecloud.com/decision/api/v2/export
请求body	{ "tableId":"agprxlvmen6upgfj2syzfvjele", "format":"excel" }
响应成功	{ "success": true, "code": "200", "message": "success", "data": "https://xxxxxxxxxxxxxxx", "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示例

成功响应中，data 为文件下载地址，通过返回的下载地址即可获取导出文件。

接口信息	说明
接口作用	根据表名获取表 ID
接口路径	/api/v1/table/{tableId}/id {tableId} 表示表名，对应第 3 节响应中的 name
请求方式	POST

响应实例：

请求示例	https://bi.finecloud.com/decision/api/v1/table/供应商合同/id
响应成功	{ "success": true, "code": "200", "message": "success", "data": [ { "id": "agprxlvmen6upgfj2syzfvjele", "name": "供应商合同" } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示例

可使用返回的 id 调用第 4 节接口，导出分析表数据。