一、标签用户列表API
此API用于获取某单个标签结果的用户列表信息
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/tag-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 |
curl --request POST \
--url https://higateway.haishuu.com/gateway/hi-api/v1/tag-users \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "xxx",
"featureName": "feature_xxx",
"baseTime":"",
"page":1,
"pageSize":1000
}'
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": 85,
"page": 1,
"result": [
{
"accountId": "15754303520",
"distinctId": "19319bebb4b1138-027f8094a8d4a3-1f525636-1930176-19319bebb4c7d51",
"userId": "1802525587458371584000001"
},
{
"accountId": "15071362331",
"distinctId": "1922c2e4a6c2833-0a62095f4d35b6-17525637-2073600-1922c2e4a6d3042",
"userId": "1802525588678914048000002"
}
]
}
}
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": {
"analysisId": "tt1",
"dataGroupType": "VALUE_NUM",
"total": 7,
"page": 1,
"result": [
{
"analysisValue": "1708"
},
{
"analysisValue": "18227"
}
]
}
}
三、错误码
接口响应状态码 |
接口响应状态码描述 |
业务响应编码 |
业务响应编码描述 |
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-12-09 09:16
最后编辑:梁松竹 更新时间:2024-12-27 11:29