海纳嗨数-帮助中心
归因分析查询API
一、归因分析查询API
此API用于客户根据书签编号获取到相应归因分析的结果查询
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/attribution-analysis-list
请求方式:POST Content-Type: application/json
接口状态:正常
2.1 请求参数
名称 | 位置 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
hi-api-key | header | String | 是 | 访问接口的权限key |
字段 | 名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
projectCode | 项目编码 | String | 是 | 该数据所属的项目编码 |
bookmarkId | 书签编号 | Long | 是 | 书签编号 |
curl --request POST \
--url https://higateway.haishuu.com/gateway/hi-api/v1/attribution-analysis-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"bookmarkId": 185xxxxxxxx8342
}'
2.2 返回参数
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
status | 接口响应状态码 | Integer | 成功=200 |
code | 业务响应编码 | String | 成功=0 |
message | 业务响应描述 | String | 操作成功 |
success | 接口成功标记 | Boolean | true 成功, false 失败 |
data | 返回数据 | List | 返回列表数据 |
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
at_event_cn | 待归因事件 | String | 待归因事件 |
at_event | 待归因事件编码 | String | 待归因事件编码 |
click_cnt | 总点击次数 | String | 总点击次数 |
valid_cnt | 有效转化点击次数 | String | 有效转化点击次数 |
valid_rate | 有效转化点击率 | String | 有效转化点击率 |
click_user_cnt | 点击用户数 | String | 点击用户数 |
valid_user_cnt | 有效点击用户数 | String | 有效点击用户数 |
valid_user_rate | 有效点击用户转化率 | String | 有效点击用户转化率 |
convert_cnt | Web浏览页面的总次数 | String | Web浏览页面的总次数 |
contribute_rate | 贡献度 | String | 贡献度 |
event.xxx | 事件属性分组字段 | String | 有分组项时存在,例如:event.event_time |
users.xxx | 用户属性分组字段 | String | 有分组项时存在,例如:users.user_name |
catalog_tag.xxx | 用户标签分组字段 | String | 有分组项时存在,例如:catalog_tag.feature_20220112_147 |
catalog_cluster.xxx | 用户分群分组字段 | String | 有分组项时存在,例如:catalog_cluster.cluster_20220124_746 |
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": [
{
"at_event_cn": "App 浏览页面",
"at_event": "H_AppViewScreen",
"click_cnt": "16753",
"valid_cnt": "431",
"valid_rate": "2.57%",
"click_user_cnt": "830",
"valid_user_cnt": "379",
"valid_user_rate": "45.66%",
"convert_cnt": "4514",
"contribute_rate": "34.8%",
"event.event": "H_AppViewScreen",
"event.platform_type": "(null)",
"catalog_tag.feature_20241122_490": "(null)",
"catalog_cluster.cluster_20241121_834": "不属于分群_20241121_834"
},
{
"at_event_cn": "Web 浏览页面",
"at_event": "H_pageview",
"click_cnt": "1094",
"valid_cnt": "33",
"valid_rate": "3.02%",
"click_user_cnt": "21",
"valid_user_cnt": "21",
"valid_user_rate": "100%",
"convert_cnt": "1306",
"contribute_rate": "10.07%",
"event.event": "H_pageview",
"event.platform_type": "(null)",
"catalog_tag.feature_20241122_490": "(null)",
"catalog_cluster.cluster_20241121_834": "不属于分群_20241121_834"
}
]
}
三、错误码
接口响应状态码 | 接口响应状态码描述 | 业务响应编码 | 业务响应编码描述 |
---|---|---|---|
200 | 成功 | 0 | 成功 |
5001 | 业务异常 | API_KEY_EXPIRED | API_KEY已过期 |
5001 | 业务异常 | NOT_IN_IP_WHITE_LIST | IP白名单限制 |
5001 | 业务异常 | API_KEY_NOT_EXISTED | API_KEY不存在 |
5001 | 业务异常 | BOOKMARK_RELY_ON_STATUS_ERROR | 书签状态异常 |
5001 | 业务异常 | BOOKMARK_TYPE_ERROR | 书签类型异常 |
6001 | 参数验证异常 | PARAM_VERIFY_FAIL | 参数验证失败 |
{
"status": 5001,
"code": "NOT_IN_IP_WHITE_LIST",
"message": "IP白名单限制 [172.23.7.64]",
"success": false,
"data": null
}
作者:超级管理员 创建时间:2024-11-27 14:46
最后编辑:梁松竹 更新时间:2024-12-10 15:43
最后编辑:梁松竹 更新时间:2024-12-10 15:43