一、分群用户列表API

此API用于获取某单个分群结果的用户列表信息

二、调用方法

API URL: https://higateway.haishuu.com/gateway/hi-api/v1/cluster-users
请求方式:POST Content-Type: application/json
接口状态:正常

2.1 请求参数

名称 位置 类型 是否必填 描述
hi-api-key header String 访问接口的权限key
字段 名称 类型 是否必填 描述
projectCode 项目编码 String 该数据所属的项目编码
featureName 分群名称 String 该数据所属的分群名称
baseTime 分群日期 String 该数据所属的分群日期范围
page 页码 Integer 页码 > 0
pageSize 每页数 Integer 每页数 1000 > pageSize > 0

2.2 返回参数

字段 名称 类型 描述
status 接口响应状态码 Integer 成功=200
code 业务响应编码 String 成功=0
message 业务响应描述 String 操作成功
success 接口成功标记 Boolean true 成功, false 失败
data 返回数据 Object
字段 名称 类型 描述
analysisId 分群分析主体ID String 分群分析主体ID 例:user_id
dataGroupType 分析主体数据类型 String 分析主体数据类型:VALUE_STR 字符型, VALUE_NUM 数值型
total 分群数据总条数 Integer 分群数据总条数
page 页码 Integer 请求页码返回
result 分群数据 List 分群集合数据
字段 名称 类型 描述
userId 用户id String 分析主体ID为user_id情况下返回
distinctId 访客id String 分析主体ID为user_id情况下返回
accountId 账户id String 分析主体ID为user_id情况下返回
analysisValue 分群分析字段值 Integer 分析主体ID为其它字段,返回对应字段的值
{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": {
        "analysisId": "user_id",
        "dataGroupType": "VALUE_STR",
        "total": 19297,
        "page": 1,
        "result": [
            {
                "accountId": "annual_report_187121000000000010019566",
                "distinctId": "annual_report_187121000000000010019566",
                "userId": "1636174355958468608111294"
            },
            {
                "accountId": "annual_report_187121000000000010019576",
                "distinctId": "annual_report_187121000000000010019576",
                "userId": "1636174357514555392111304"
            }
        ]
    }
}
{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": {
        "analysisId": "collect_cnt",
        "dataGroupType": "VALUE_NUM",
        "total": 97,
        "page": 1,
        "result": [
            {
                "analysisValue": "2827"
            },
            {
                "analysisValue": "2827"
            }
        ]
    }
}

三、错误码

接口响应状态码 接口响应状态码描述 业务响应编码 业务响应编码描述
200 成功 0 成功
5001 业务异常 API_KEY_EXPIRED API_KEY已过期
5001 业务异常 NOT_IN_IP_WHITE_LIST IP白名单限制
5001 业务异常 API_KEY_NOT_EXISTED API_KEY不存在
5001 业务异常 DATA_NOT_EXISTED 数据不存在
6001 参数验证异常 PARAM_IS_EMPTY 参数为空
{
    "status": 5001,
    "code": "DATA_NOT_EXISTED",
    "message": "数据不存在",
    "success": false,
    "data": null
}
{
    "status": 5001,
    "code": "NOT_IN_IP_WHITE_LIST",
    "message": "IP白名单限制 [172.23.7.64]",
    "success": false,
    "data": null
}

四、限制

类型 调用限制 描述
普通用户 QPS:5次/秒 接口限制
作者:超级管理员  创建时间:2024-05-09 14:19
最后编辑:超级管理员  更新时间:2024-10-31 14:08