海纳嗨数-帮助中心
分布分析查询API
一、分布分析查询API
此API用于客户根据书签编号获取到相应分布分析的结果查询
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/distribution-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/distribution-analysis-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"bookmarkId": 185xxxxxxxx3342
}'2.2 返回参数
| 字段 | 名称 | 类型 | 描述 |
|---|---|---|---|
| status | 接口响应状态码 | Integer | 成功=200 |
| code | 业务响应编码 | String | 成功=0 |
| message | 业务响应描述 | String | 操作成功 |
| success | 接口成功标记 | Boolean | true 成功, false 失败 |
| data | 返回数据 | List | 返回列表数据 |
| 字段 | 名称 | 类型 | 描述 |
|---|---|---|---|
| pk_day | 时间 | String | 分析时间 |
| bins | 分组 | String | 分组 |
| bins.measure | 指标分箱 | String | 指标分箱 |
| userscnt | 总用户数 | Integer | 分析总用户数 |
| userscnt_bins | 分箱用户数 | Integer | 分箱用户数 |
| sub_userscnt | 分组项内总用户数 | Integer | 分组项内总用户数 |
| sub_userscnt_bins | 分组项内分箱用户数 | Integer | 分组项内分箱用户数 |
| linkdisplay_calres | 同时展示-总计算值 | Integer | 同时展示-总计算值 |
| linkdisplay_calres_bins | 同时展示-分箱计算值 | Integer | 同时展示-分箱计算值 |
| linkdisplay_sub_calres | 同时展示-分组项内总计算值 | Integer | 同时展示-分组项内总计算值 |
| linkdisplay_sub_calres_bins | 同时展示-分组项内分箱计算值 | Integer | 同时展示-分组项内分箱计算值 |
| 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": [
{
"pk_day": "2024-11-21",
"event.event": "H_pageview",
"event.timezone_offset": "-480",
"bins": "H_pageview,-480",
"bins.measure": "[1,52)",
"userscnt": 4,
"userscnt_bins": 3,
"sub_userscnt": 4,
"sub_userscnt_bins": 3
},
{
"pk_day": "2024-11-21",
"event.event": "H_pageview",
"event.timezone_offset": "-480",
"bins": "H_pageview,-480",
"bins.measure": "[52,103)",
"userscnt": 4,
"userscnt_bins": 1,
"sub_userscnt": 4,
"sub_userscnt_bins": 1
}
]
}同时展示:
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": [
{
"pk_day": "2024-11-21",
"event.event": "H_pageview",
"event.timezone_offset": -480,
"bins": "H_pageview,-480",
"bins.measure": "[52,103)",
"userscnt": 4,
"userscnt_bins": 1,
"sub_userscnt": 4,
"sub_userscnt_bins": 1,
"linkdisplay_calres": 83,
"linkdisplay_calres_bins": 74,
"linkdisplay_sub_calres": 83,
"linkdisplay_sub_calres_bins": 74
},
{
"pk_day": "2024-11-21",
"event.event": "H_pageview",
"event.timezone_offset": -480,
"bins": "H_pageview,-480",
"bins.measure": "[1,52)",
"userscnt": 4,
"userscnt_bins": 3,
"sub_userscnt": 4,
"sub_userscnt_bins": 3,
"linkdisplay_calres": 83,
"linkdisplay_calres_bins": 9,
"linkdisplay_sub_calres": 83,
"linkdisplay_sub_calres_bins": 9
}
]
}三、错误码
| 接口响应状态码 | 接口响应状态码描述 | 业务响应编码 | 业务响应编码描述 |
|---|---|---|---|
| 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次/秒 | 接口限制 |
作者:梁松竹 创建时间:2024-12-02 13:57
最后编辑:梁松竹 更新时间:2025-09-19 16:03
最后编辑:梁松竹 更新时间:2025-09-19 16:03