图表API服务

更新时间:2023-07-20

图表 API 服务将报表中图表的数据和可视化结果服务化,可以通过 openAPI 的方式获取报表中图表的数据结果或截图。 与数据模型服务不同的是,图表 API 服务可以获取到的数据是按各类图表类型格式化后的数据,支持系统中所有主流图表,且兼容 SQL建模,API,数据模型和静态 JSON 等所有图表数据绑定方式。同时还可以在 openAPI 的参数中,控制图表所在报表的页面级过滤条件,从而对图表的数据结果进行筛选。

图表 API 服务的使用需要拥有空间管理员权限或者赋予了数据服务权限的用户或者角色才能使用。

注: 该功能仅适用于私有部署版本中使用。

设置流程

1、数据服务权限

数据服务权限可以在「系统设置 -> 用户管理 -> 权限配置」中进行设置(也可以设置角色的数据服务权限使角色中所有用户拥有数据服务权限)。

图片

2、新建图表 API 服务

在报表的图表上右键选择「图表API服务」:

图片

填写图表API服务的名称和说明即可,如果有需要,还可以设置图表截图时,对应的报表分辨率:

图片

3、在左侧边栏 -> 数据服务 -> 图表 API 服务 Tab 下,可以找到创建的 API 服务,并可以通过条件过滤:

图片

4、接下来就可以使用 openAPI 调用图表 API 服务了。

调用 openAPI 时图表中的数据权限与图表 API 服务创建者的权限相同

调用方式

创建数据服务 ak/sk

在使用图表API服务接口获取计算结果前需要先通过「系统设置 -> 空间 Access Key -> 数据服务」创建 aksk 然后通过创建的 aksk 计算签名信息,用于访问图表API服务接口时的权限认证,签名的计算方式和openAPI一致。

图片

然后携带签名信息通过「openAPI -> V2」中的图表API服务服务接口进行调用:图表API服务

本页内容