帮助中心
- 平台介绍
- 接入指引
- 版本信息
- 使用流程
- 功能手册
- 操作视频
- 技术文档
- 基础知识
- 客户端SDK
- 服务端SDK
- 数据导入
- API功能
- SQL手册
- DML
- SQL函数
- 日期函数
- convert_tz
- curdate,current_date
- current_timestamp
- curtime,current_time
- date_add
- date_format
- date_sub
- datediff
- day
- dayname
- dayofmonth
- dayofweek
- dayofyear
- from_days
- from_unixtime
- hour
- makedate
- minute
- month
- monthname
- now
- second
- str_to_date
- time_round
- timediff
- timestampadd
- timestampdiff
- to_date
- to_days
- unix_timestamp
- utc_timestamp
- week
- weekday
- weekofyear
- year
- yearweek
- localtime,localtimestamp
- quarter
- last_day
- extract
- date_trunc
- minutes_add
- minutes_diff
- minutes_sub
- seconds_add
- seconds_diff
- seconds_sub
- hours_add
- hours_diff
- hours_sub
- days_add
- days_diff
- days_sub
- weeks_add
- weeks_diff
- weeks_sub
- months_add
- months_diff
- months_sub
- years_add
- years_diff
- years_sub
- 字符串函数
- append_trailing_char_if_absent
- to_base64
- from_base64
- ascii
- length
- bit_length
- char_length
- lpad
- rpad
- lower
- lcase
- upper
- ucase
- initcap
- repeat
- reverse
- char
- concat
- concat_ws
- substr
- substring
- sub_replace
- ends_with
- starts_with
- trim
- ltrim
- rtrim
- null_or_empty
- not_null_or_empty
- hex
- unhex
- elt
- instr
- locate
- find_in_set
- replace
- left
- right
- strleft
- strright
- split_part
- split_by_string
- substring_index
- money_format
- parse_url
- convert_to
- extract_url_parameter
- uuid
- space
- sleep
- 日期函数
- 数据类型
- 数据管理
- 常见问题
- 合规说明
- 资源下载
- AB测试
用户分群列表查询API
一、用户分群列表查询API
此API用于查询客户该项目下的所有分群的列表信息
此API正在研发中……
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/catalog-cluster-list
请求方式: POST Content-Type: application/json
接口状态:正常
2.1 请求参数
名称 | 位置 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
hi-api-key | header | String | 是 | 访问接口的权限key |
字段 | 名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
projectCode | 项目编码 | String | 是 | 该数据所属的项目编码 |
startTime | 开始时间 | String | 否 | 查询区间的开始时间,格式:yyyy-MM-dd HH:mm:ss,例如:2024-09-01 00:00:00 |
endTime | 结束时间 | String | 否 | 查询区间的结束时间,格式:yyyy-MM-dd HH:mm:ss,例如:2024-09-18 00:00:00 |
createSource | 创建方式 | String | 否 | 创建方式,参数为空时查询所有创建方式的分群,包括结果分群、自定义分群、SQL分群、导入分群,例如:自定义分群 |
curl --request POST \
--url https://higateway.haishuu.com/gateway/hi-api/v1/catalog-cluster-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"startTime": "2024-09-14 00:00:00",
"endTime": "2024-09-15 00:00:00",
"createSource": "结果分群"
}'
2.2 返回参数
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
status | 接口响应状态码 | Integer | 成功=200 |
code | 业务响应编码 | String | 成功=0 |
message | 业务响应描述 | String | 操作成功 |
success | 接口成功标记 | Boolean | true 成功, false 失败 |
data | 返回数据 | List | 返回列表数据 |
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
name | 分群名称 | String | 分群名称 |
cname | 分群显示名 | String | 分群显示名 |
createSourceDesc | 创建方式 | String | 创建方式,包括结果分群、自定义分群、SQL分群、导入分群 |
isRoutineDesc | 更新方式 | String | 更新方式,包括例行、手动、不更新 |
isBackupDesc | 备份方式 | String | 备份方式,包括自动备份、不备份 |
analysisDesc | 分析主体 | String | 分析主体,包括海纳ID和用户自定义的分析主体 |
lastUpdateTime | 规则更新时间 | String | 规则更新时间 |
lastComputingTime | 最新计算时间 | String | 最新计算时间 |
overwriteUsers | 分群覆盖用户数 | Long | 分群覆盖用户数 |
createUserName | 创建人 | String | 创建人 |
createTime | 创建时间 | String | 创建时间 |
updateUserName | 更新人 | String | 更新人 |
updateTime | 更新时间 | String | 更新时间 |
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": [
{
"name": "cluster_20240914_135",
"cname": "分布分析0914",
"clusterGroup": null,
"createSourceDesc": "结果分群",
"clusterTypeDesc": "布尔",
"isRoutineDesc": "不更新",
"isBackupDesc": "不备份",
"analysisDesc": "tt1-用户属性",
"lastUpdateTime": null,
"lastComputingTime": "2024-09-14 14:02:00",
"overwriteUsers": 2,
"createUserName": "管理员",
"createTime": "2024-09-14 14:02:00",
"updateUserName": null,
"updateTime": null
},
{
"name": "cluster_20240914_762",
"cname": "分布分析结果分群2",
"clusterGroup": null,
"createSourceDesc": "结果分群",
"clusterTypeDesc": "布尔",
"isRoutineDesc": "不更新",
"isBackupDesc": "不备份",
"analysisDesc": "tt1-事件属性",
"lastUpdateTime": null,
"lastComputingTime": "2024-09-14 14:12:38",
"overwriteUsers": 7,
"createUserName": "管理员",
"createTime": "2024-09-14 14:12:38",
"updateUserName": null,
"updateTime": null
}
]
}
三、错误码
接口响应状态码 | 接口响应状态码描述 | 业务响应编码 | 业务响应编码描述 |
---|---|---|---|
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-09-18 14:11
最后编辑:超级管理员 更新时间:2024-09-19 18:13
最后编辑:超级管理员 更新时间:2024-09-19 18:13