1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | - |
1.2 应用场景
需要按维度查看度量背后的明细数据时，可通过本接口直接查询。
metrics 只能传入一个度量或明细指标；
维度必须来自该度量的相关维度，可通过「查看度量相关维度」接口获取；
日期分组只改变展示粒度，不改变返回的行数；
度量排序写在 source 对应项的 sort 中，1 升序、2 降序、0 或 3 或不传为不排序；
orders 表示结果列顺序，且需覆盖全部维度和度量。
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
接口作用 | 按指标集、维度、度量查询明细数据，不聚合，支持分页与排序 |
接口 URL | /api/dc/{version}/indicator/query/detail |
请求类型 | POST |
2.2 请求参数
Header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
version | string | 是 | 接口版本号，示例：v1 |
Body 参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
metricSet | string | 是 | 模型指标集 id |
dimensions | array[string] | 否 | 查询使用的维度，必须是 metrics 中所传度量的相关维度 |
metrics | array[string] | 是 | 查询使用的度量，只能有一个度量或明细指标 |
filters | array[object] | 否 | 过滤条件 |
orders | array[string] | 是 | 结果列顺序，需覆盖全部维度和度量 |
source | objectye | 是 | 各字段的查询配置，键为字段标识，值为 QueryField 对象，说明见下表 |
limit | object | 是 | 分页配置，说明见下表 |
engineType | string | 否 | 查询引擎类型 |
——source 中每个字段的配置：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
fieldId | string | 否 | 字段 id |
name | string | 否 | 字段名称 |
type | integer | 否 | 字段类型 |
resourceType | integer | 否 | 资源类型：66 表示维度、82 表示度量、65 表示指标 |
group | object | 否 | 日期展示粒度，只改格式不聚合 |
sort | integer | 否 | 排序方式：1 表示升序、2 表示降序、0和3 表示不排序 |
——limit 中的参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| rowCount | integer | 否 | 拉取行数，小于等于 0 表示不截断 |
pageSize | integer | 否 | 每页返回的行数 |
pageIndex | integer | 否 | 页码，用于指定返回第几页数据 |
2.3 请求示例
| 示例 | |
|---|---|
请求地址 | POST http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/query/detail |
请求头 | Authorization: ******************** |
请求体 | 见下方代码块 |
2.4 返回示例
{
"success": true,
"code": "string",
"message": "string",
"data": {
"fields": [
{}
],
"data": [
[
null
]
],
"pageInfo": {
"rowCount": 0,
"pageSize": 0,
"pageIndex": 0
}
},
"errorCode": "string",
"errorMsg": "string"
}
响应参数说明
| 参数 | 参数值说明 |
|---|---|
success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 返回的数据，包含字段列表、数据行与分页信息 |
data.fields | 字段列表，每个元素对应结果中的一列 |
data.data | 数据行，二维数组。外层为行，内层为该行的各字段值，顺序与 data.fields 一致 |
data.pageInfo | 本次取数的分页信息 |
data.pageInfo.rowCount | 拉取行数，小于等于 0 表示不截断 |
data.pageInfo.pageSize | 每页返回的行数 |
data.pageInfo.pageIndex | 页码 |
errorCode | 错误码 |
errorMsg | 错误信息 |
上一篇：指标数据查询/校验接口
