参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | 是 | 1 | 计算结果id |
无
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
msg | String | 成功 | 接口返回信息 |
code | Number | 0 | 状态码,0表示正常 |
data | AnalysisModuleWebResultResp | {} | 接口返回数据体 |
traceId | String | xxx-xx-123 | 跟踪id |
AnalysisModuleWebResultResp
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
msg | String | success | 异常信息 |
seg | JsonNode | {} | 分群信息 |
name | String | 指标 | 指标名称 |
type | String | NORMAL | 分析类型: |
descr | String | 描述 | 指标描述 |
period | BasePeriod | {} | 时间 |
result | Array | [] | 计算结果 |
status | String | Succeed | 计算状态: |
metrics | BaseMetrics | {} | 指标 |
resultId | Int | 1 | 结果ID |
dimension | BaseDimension | {} | 维度 |
extraJson | JsonNode | {} | 额外信息 |
subjectId | Int | 1 | 主体ID |
displayConfig | JsonNode | {} | 展示配置 |
analysisModuleObjId | Int | 1 | 模块id |
BasePeriod
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
num | Int | 1 | 时间单位量 |
name | String | 天 | 事件单位名称 |
type | String | RANGE | 类型: |
offset | Int | 2 | 日期偏移 |
endTime | String | 2020-01-01 10:00:00 | 结束时间 |
baseTime | String | 2020-01-01 00:00:00 | 基准时间 |
startTime | String | 2020-01-01 08:00:00 | 开始时间 |
periodRange | Sring | DAY | 时间单位: |
BaseAnalysisResultObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
num | Int | 12034 | 当日值 |
data | Array | [] | 二维表格 |
date | String | 2020-01-01 09:00:00 | 日期 |
name | String | 名称 | 名称 |
details | Array | [] | 数据详情 |
metrics | Array | [] | 指标详情 |
demensions | JsonNode | {} | 维度 |
decreaseNum | Int | 12 | 减少 |
increaseNum | Int | 34 | 新增 |
pathFindResultNodeObjs | Array | [] | 路径分析节点信息 |
pathFindResultPathObjs | Array | [] | 路径分析流转信息 |
LabelValue
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
label | String | 显示名 | 显示名 |
value | String | 值 | 值 |
SimpleDynamicResultDetailObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
name | String | 名称 | 名称 |
value | Int | 208 | 值 |
MetricsInfoObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | Int | 1 | 指标ID |
name | String | 指标名称 | 指标名称 |
formatEnum | String | INTEGER | 指标数据类型: |
PathFindResultNodeObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
key | String | 1 | 节点key |
num | Int | 1 | 节点数量 |
name | String | 测试节点 | 节点名称 |
prop | String | 属性 | 节点属性 |
level | Int | 1 | 层级 |
lossNum | Int | 0 | 流失数量 |
lossRate | Int | 0 | 流失率 |
transNum | Int | 0 | 流转数量 |
transRate | Int | 0 | 流转率 |
PathFindResultPathObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
num | Int | 1 | 数量 |
loss | Boolean | false | 是否流失路径 |
rate | Int | 0 | 转化率,百分数 |
level | Int | 1 | 层级 |
endNode | String | node | 结束节点Key |
startNode | String | node | 开始节点Key |
middleNode | Array | [] | 中间节点Key |
avgTransTime | Int | 1 | 平均转化周期,天 |
BaseMetrics
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
name | String | 指标 | 指标名称 |
limit | Int | 1 | 指标数量限制 |
method | String | SUM | 指标计算模型: |
period | BasePeriod | {} | 时间 |
function | FunctionObj | {} | 函数 |
metricsId | Int | 1 | 指标ID |
formatEnum | String | INTEGER | 展示方式: |
metricsList | Array | [] | 多指标对象 |
simpleFormat | Boolean | false | 简单格式化 |
metricsCnName | String | 指标 | 指标中文名称,只用于模版,用户名称和id的替换 |
attributionObj | AnalysisAttributionObj | {} | 分析对象 |
targetIdTypeId | Int | 1 | 计算输出的id类型 |
attributionType | String | FIRST | 归因分析模型: |
attributionEvent | Array | [] | 属性事件 |
analysisAttributionObjs | Array | [] | 分析对象 |
FunctionObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
nodes | Array | {} | 节点 |
function | String | 方法 | 方法 |
AnalysisAttributionObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
attr | Array | [] | 分析属性 |
name | String | 名称 | 维度统一名称,用于行为圈选时展示 |
type | String | TAG | 维度信息类型: |
index | Int | 1 | id |
limit | Int | 10 | 维度数量限制,按照维度数量进行降序 |
nodes | Array | [] | 子节点 |
tagId | Int | 2 | 标签id,type=TAG时有效 |
attrId | Int | 3 | 预定义维度id,type=ATTR时有效 |
endObj | PathObj | {} | 结束节点 |
method | String | SUM | 计算方式: |
segIds | Array | [1,2] | 人群id,只有type为SEG时有效 |
values | Array | [小学,初中] | 用户指定维度 |
breakUp | Boolean | false | 是否打散,只用于行为 |
eventId | Int | 3 | 行为id,只有type为EVENT时有效 |
exclude | JosnNode | {} | 排除选项 |
include | JsonNode | {} | 包含选项 |
columnId | Int | 4 | 字段列id,只有type为DETAIL时有效 |
distinct | Boolean | false | 是否去重 |
segRules | Array | [] | 人群规则,只有type为SEG_RULE时有效 |
startObj | PathObj | {} | 开始节点 |
condition | EventAttributionObjCondition | {} | 条件 |
eventName | String | click | 行为查询值,只有type为EVENT时有效 |
eventType | Int | 0 | 行为事件类型,0:普通事件;1:虚拟事件,可选,默认0 |
columnName | String | edu | 字段列id,只有type为DETAIL时有效 |
rangeValues | Array | [] | 区间维度,如果传入区间维度,则优先识别 |
dataSourceId | Int | 2 | 数据源id,只有type为DETAIL时有效 |
propertyType | Int | 1 | 属性类型,显示声明3是虚拟属性,其他都是普通属性,值为1 |
windowPeriod | BasePeriod | {} | 窗口 |
dimColumnName | String | edu | 维度属性名称 |
objDataPeriod | BasePeriod | {} | 数据时间 |
dateGroupRange | String | DAY | 日期维度聚合类型:YEAR、MONTH、WEEK、DAY、HOUR、MINUTE |
dateSplitIndex | Int | 0 | 日期维度切片位置 |
dateBasePeriods | Array | [] | 自定义日期维度 |
dimDataSourceId | Int | 37 | 维度属性数据源id |
filterCondition | JsonNode | {} | 过滤条件 |
eventAttributeId | Int | 5 | 行为属性id,只有type为EVENT时有效 |
eventDatasourceId | Int | 32 | 行为表id,只有type为EVENT时有效 |
eventAttributeName | String | pay | 行为属性名称,只有type为EVENT时有效 |
attributeValueMapping | Map<String,Object> | {} | 属性值mapping |
analysisAttributionObjs | Array | [] | 子节点信息 |
PathObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
tagId | Int | 1 | 标签id |
values | Array | [小学,初中] | 标签值 |
SegRuleObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
date | String | 2022-02-01 | 人群日期 |
segName | String | 测试上传分群 | 人群包名称 |
segFilter | JsonNode | {} | 圈选条件 |
EventAttributionObjCondition
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
logic | String | Or | 处理逻辑:Or、And、OR、AND |
filters | Array | [] | 具体过滤条件 |
EventAttributionFilter
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
attr | AttributionObj | {} | 属性 |
value | Object | {} | 值 |
values | Array | [点击,分享] | 值列表 |
columnId | Int | 1 | 列ID |
operator | String | xx | 操作 |
valueMap | Map<String,Object> | {} | 值映射 |
paramName | String | param | 前端组件问题, paramName 和 columnName 二选一 |
columnName | String | column | 前端组件问题, paramName 和 columnName 二选一 |
operatorEnum | String | in | 操作: |
propertyType | Int | 2 | 虚拟属性类型 |
dimColumnName | String | edu | 虚拟属性名称 |
dimDataSourceId | Int | 37 | 维度属性数据源id |
eventAttributeId | Int | 3 | 事件属性id |
eventAttributeName | String | 点击 | 事件属性名称 |
RangeValueObj
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
max | String | 18 | 最大值 |
min | String | 25 | 最小值 |
name | String | 青少年 | 区间名称 |
leftClose | Boolean | true | 是否包含最小值, 默认 true |
rightClose | Boolean | true | 是否包含最大值, 默认 false |
BaseDimension
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
type | String | ATTRIBUTION | 分析类型:USER_TENDENCY、TRANS、ATTRIBUTION、ATTRIBUTION_COLUMN、NORMAL、NORMAL_COLUMN、CROSS_DIMENSION、NORMAL_COLUMN_LINKAGE、NORMAL_COUNT、CROSS_DIMENSION_MERGE、EXTRA |
dateAggregate | Boolean | true | 是否按日期聚合 |
attributionObj | AnalysisAttributionObj | {} | 分析对象 |
attributionObjs | Array | [] | 交叉维度 |
attributionEvent | Array | [] | 分析对象 |
dimensionFilters | Array<> | [] | 用于过滤需要使用的维度,主要用于交叉维度场景,二维数组,子数组顺序表示了需要保留的交叉维度 |
GET /?ApiAction=getResultById&ApiVersion=2024-05-22&resultId=1
{ "code": 0, "msg": "success", "data": { "seg": null, "dimension": { "type": "NORMAL_COLUMN", "attributionObj": { "type": "EVENT", "eventDatasourceId": 107, "eventId": 120, "eventName": "phone", "condition": { "logic": "And", "filters": [ { "eventAttributeId": null, "columnId": null, "eventAttributeName": "ug_source", "dimDataSourceId": null, "dimColumnName": null, "columnName": "ug", "propertyType": null, "paramName": null, "attr": null, "values": [ "kuaishou" ], "valueMap": null, "value": null, "operator": "in", "operatorEnum": "in" } ] }, "distinct": false, "breakUp": true, "method": "COUNT" } }, "period": { "startTime": "2024-06-11", "endTime": "2024-06-12", "type": "DATE" }, "metrics": { "method": "ID", "formatEnum": "INTEGER", "metricsId": 314 }, "type": "NORMAL_COLUMN", "analysisModuleObjId": -1, "resultId": 1760, "result": [ { "date": "2024-06-11", "name": "符合行为条件", "num": 500.0, "dimensions": { "date": "2024-06-11", "period": "2024-06-11 - 2024-06-12", "dimensionKey1": "符合行为条件" }, "metrics": { "id": -1, "name": "弱渠道关联4-dianj2人数", "formatEnum": "INTEGER" } } ], "status": "Succeed", "msg": null, "name": null, "descr": null, "displayConfig": { "dimensions": [ { "key": "dimensionKey1", "name": "phone" } ], "metrics": [ { "id": -1, "name": "弱渠道关联4-dianj2人数", "formatEnum": "INTEGER" } ], "weakLink": false }, "subjectId": 1, "extraJson": null } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法,检查入参。 |