海纳嗨数-帮助中心
事件分析下载API
一、事件分析下载API
此API用于客户根据书签编号获取到相应事件分析的下载结果
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/event-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/event-analysis-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"bookmarkId": 184xxxx7010
}'
2.2 返回参数
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
status | 接口响应状态码 | Integer | 成功=200 |
code | 业务响应编码 | String | 成功=0 |
message | 业务响应描述 | String | 操作成功 |
success | 接口成功标记 | Boolean | true 成功, false 失败 |
data | 返回数据 | List | 返回列表数据 |
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
analysis_name | 分析指标名称 | String | 分析指标名称 |
pk_day | 时间 | String | 时间 |
calres | 计算结果 | Long | 计算结果 |
动态分组字段 | 分组字段 | String | 多个分组就返回多个字段,如 event.event,event.distinct_id |
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": [
{
"pk_day": "2024-10-28",
"calres": 962,
"event.timezone_offset": "-480",
"event.event_time": "2024-10-28",
"analysis_name": "Web 浏览页面.总次数"
}
]
}
三、错误码
接口响应状态码 | 接口响应状态码描述 | 业务响应编码 | 业务响应编码描述 |
---|---|---|---|
200 | 成功 | 0 | 成功 |
5001 | 业务异常 | API_KEY_EXPIRED | API_KEY已过期 |
5001 | 业务异常 | NOT_IN_IP_WHITE_LIST | IP白名单限制 |
5001 | 业务异常 | API_KEY_NOT_EXISTED | API_KEY不存在 |
6001 | 参数验证异常 | PARAM_VERIFY_FAIL | 参数验证失败 |
{
"status": 5001,
"code": "NOT_IN_IP_WHITE_LIST",
"message": "IP白名单限制 [172.23.7.64]",
"success": false,
"data": null
}
作者:超级管理员 创建时间:2024-10-22 16:17
最后编辑:梁松竹 更新时间:2024-10-31 14:08
最后编辑:梁松竹 更新时间:2024-10-31 14:08