图表API服务
更新时间：2023-12-27
获取图表API服务结果
接口简介
获取图表API服务结果
接口详情
请求地址
/openapi/v2/group/{groupKey}/imgService/:hash
请求类型
POST
请求参数
| 参数名 | 位置 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|---|
| hash | url | String | 是 | 图表API服务 hash（在图表API服务管理页面进行查询） | 无 | isa_ada15-5qxhvy3u-b2zyk1 |
| resultType | body | String | 否 | 返回结果形式：json格式数据/图表截图 | 无 | json/img |
| reportParams | body | String | 否 | 对应报表的url筛选参数，可以对图表数据进行筛选。不传时使用报表中过滤条件的默认值 | 无 | 参考下面的请求示例 |
请求示例
鉴权方式
在使用图表API服务接口获取计算结果前需要先通过「系统设置->空间 Access Key->数据服务」创建 aksk 然后通过创建的 aksk 计算签名信息，用于访问图表API服务接口时的权限认证，签名的计算方式和openAPI一致。
请求示例
例如我们对下图中的表格图表创建了一个图表API服务：
在图表API服务管理中可以找到对应的服务Hash：
通过 resultType 参数可以控制返回结果的形式是json还是图片，图片形式：
通过 reportParams 参数可以控制图表所在报表的过滤条件取值和url参数绑定取值，从而控制图表API的数据筛选。
可以看到当前这个报表的默认筛选条件取值是 2019-03-01 到 2019-03-02，地区为华东：
reportParams参数的格式与上图报表url中参数格式一致，报表url中可以使用的筛选和url参数关联都可以放在reportParams里，注意这个参数里的内容需要做url参数编码。
例如现在想让图表API返回 2019-04-01 - 2019-04-03，华北的数据：
如果图表配置了关联URL参数，也可以直接在这里使用，如这个表格配置对产品类别的URL参数关联，也可以将配置的URL关联加入参数中进行筛选：
返回示例正确示例
json 形式
返回的json都会有 status 字段， status 为 0 代表成功。成功时数据会在 data 字段中，data 字段的格式与图表种类有关，可参考各种图表的API格式要求。表格的示例如下：
{
"status": 0,
"data": {
"columns": [
{
"id": "订单日期",
"frontendId": "FLKAKLKMT1UKZE",
"name": "订单日期"
},
{
"id": "地区",
"frontendId": "FLKAKLMLP2Q1UT",
"name": "地区"
},
{
"id": "产品类别",
"frontendId": "FLKAKLQB82YWQL",
"name": "产品类别"
},
{
"id": "数量",
"frontendId": "FLKAKLSYT1HXAO",
"name": "数量"
}
],
"rows": [
{
"订单日期": "2019-04-01",
"地区": "华北",
"产品类别": "家居",
"数量": 4
},
{
"订单日期": "2019-04-02",
"地区": "华北",
"产品类别": "家居",
"数量": 2
},
{
"订单日期": "2019-04-03",
"地区": "华北",
"产品类别": "家居",
"数量": 3
}
]
}
}图片形式
返回图表截图
返回错误示例
{
msg: '错误详情',
status: 499,
requestId: ''
}