一、间隔分析查询API
此API用于客户根据书签编号获取到相应间隔分析的结果查询
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v2/interval-analysis-list
请求方式:POST Content-Type: application/json
接口状态:正常
2.1 请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| hi-api-key |
header |
String |
是 |
访问接口的权限key【获取hi-api-key】 |
| 字段 |
名称 |
类型 |
是否必填 |
描述 |
| projectCode |
项目编码 |
String |
是 |
该数据所属的项目编码【项目编码获取】 |
| bookmarkId |
书签编号 |
Long |
是 |
书签ID【书签编号获取】 |
| page |
页码 |
Integer |
是 |
页码 > 0 |
| pageSize |
每页数 |
Integer |
是 |
每页数 1000 >= pageSize > 0 |
curl --request POST \
--url https://higateway.haishuu.com/gateway/hi-api/v2/interval-analysis-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"bookmarkId": 185xxxxxxxx3342,
"page":1,
"pageSize":1000
}'
2.2 返回参数
| 字段 |
名称 |
类型 |
描述 |
| status |
接口响应状态码 |
Integer |
成功=200 |
| code |
业务响应编码 |
String |
成功=0 |
| message |
业务响应描述 |
String |
操作成功 |
| success |
接口成功标记 |
Boolean |
true 成功, false 失败 |
| data |
返回数据 |
Oject |
返回数据 |
| 字段 |
名称 |
类型 |
描述 |
| total |
数据总条数 |
Integer |
数据总条数 |
| page |
页码 |
Integer |
请求页码返回 |
| result |
分析数据 |
List |
分析数据 |
| 字段 |
名称 |
类型 |
描述 |
| pk_day |
时间 |
String |
分析时间 |
| users_cnt |
用户数 |
Integer |
用户数 |
| intervals_cnt |
间隔数 |
Integer |
间隔数 |
| mean |
平均值 |
Integer |
平均值 |
| min |
最小值 |
Integer |
最小值 |
| max |
最大值 |
Integer |
最大值 |
| lower_percentile |
下四分位 |
Integer |
|
| median_percentile |
中位数 |
Integer |
|
| upper_percentile |
上四分位 |
Integer |
|
| json_array_users |
用户数数组 |
String |
|
| json_array_intervals |
间隔数数组 |
String |
|
| event.xxx.xxx |
事件属性分组字段 |
String |
有分组项时存在,例如:event.H_pageView.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 |
{
"code": "0",
"data": {
"page": 1,
"result": [
{
"catalog_cluster.cluster_20241205_250": "总体",
"catalog_tag.feature_20240925_013": "总体",
"event.H_login.zone": "-480",
"event.H_pageview.event": "总体",
"intervals_cnt": 22,
"json_array_intervals": "[19,1,0,0,1,1,0,0,0,0,0,0]",
"json_array_users": "[2,1,0,0,1,1,0,0,0,0,0,0]",
"lower_percentile": 6,
"max": 1573,
"mean": 192,
"median_percentile": 12,
"min": 2,
"pk_day": "总体",
"upper_percentile": 67,
"users.H_city": "总体",
"users_cnt": 2
},
{
"catalog_cluster.cluster_20241205_250": "属于cluster_20241205_250",
"catalog_tag.feature_20240925_013": "(null)",
"event.H_login.zone": "-480",
"event.H_pageview.event": "H_pageview",
"intervals_cnt": 22,
"json_array_intervals": "[19,1,0,0,1,1,0,0,0,0,0,0]",
"json_array_users": "[2,1,0,0,1,1,0,0,0,0,0,0]",
"lower_percentile": 6,
"max": 1573,
"mean": 192,
"median_percentile": 12,
"min": 2,
"pk_day": "2024-12-05",
"upper_percentile": 67,
"users.H_city": "上海",
"users_cnt": 2
}
],
"total": 2
},
"message": "操作成功",
"status": 200,
"success": true
}
三、错误码
| 接口响应状态码 |
接口响应状态码描述 |
业务响应编码 |
业务响应编码描述 |
| 200 |
成功 |
0 |
成功 |
| 5001 |
业务异常 |
API_SERVICE_FAIL |
查询参数缺失 |
| 5001 |
业务异常 |
API_PROCESS_FAIL |
查询引擎发生错误 |
| 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
}
四、限制
| 类型 |
调用限制 |
描述 |
| 普通用户 |
QPS:2次/秒 |
接口限制 |
作者:梁松竹 创建时间:2025-01-16 10:42
最后编辑:梁松竹 更新时间:2025-09-19 16:03