参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | String | 是 | 1 | 项目id |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ApiAction | String | 是 | getResultById | 对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2024-05-22 | 版本号: 2024-05-22 |
resultId | Int | 是 | 计算结果id |
无
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
msg | String | 成功 | 接口返回信息 |
code | Number | 0 | 状态码,0表示正常 |
data | Object | 接口返回数据体 | |
traceId | String | 跟踪id |
data字段内容
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
seg | JsonNode | 人群条件 | |
dimension | BaseDimension | 维度条件 | |
period | BasePeriod | 时间周期 | |
metrics | BaseMetrics | 指标计算 | |
type | String | 分析类型 | |
analysisModuleObjId | Int | 模块id | |
resultId | Int | 结果id | |
result | Array | 计算结果 | |
status | String | 计算状态 | |
msg | String | 异常信息 | |
name | String | 指标名称 | |
descr | String | 指标描述 | |
displayConfig | JsonNode | 前端展示结构 | |
subjectId | Int | ||
extraJson | JsonNode |
无
无
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法,检查入参。 |