海纳嗨数-帮助中心
用户分群导入API
一、用户分群导入API
此API用于客户在所属项目下的对分群进行导入
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/catalog-cluster-import
请求方式:POST Content-Type: multipart/form-data
接口状态:正常
2.1 请求参数
名称 | 位置 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
hi-api-key | header | String | 是 | 访问接口的权限key |
字段 | 名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
projectCode | 项目编码 | String | 是 | 该数据所属的项目编码 |
name | 分群名 | String | 是 | 分群名,最大长度50个字符 |
cname | 分群显示名 | String | 是 | 分群显示名,最大长度64个字符 |
analysisSubject | 分析主体 | String | 是 | 分析主体编码,例如:user_id |
analysisIdTable | 分析主体表类型 | String | 否 | 分析主体表类型,分析主体不是user_id时必填,例如:event |
relationAttrCode | 关联属性 | String | 否 | 关联属性,分析主体是user_id时必填,例如:distinct_id |
remark | 分群备注 | String | 否 | 分群备注,最大长度256个字符 |
file | 分群规则文件 | File | 是 | 分群规则文件,请参考Sass平台用户分群导入的模板文件 |
curl --request POST \
--url https://higateway.haishuu.com/gateway/hi-api/v1/catalog-cluster-import \
--header 'Content-Type: multipart/form-data' \
--header 'hi-api-key: #K-xxx' \
--form projectCode=projectCode \
--form name=import_cluster_001 \
--form cname=import_cluster_001 \
--form analysisSubject=user_id \
--form remark=remark \
--form 'file=/data/import_cluster.csv' \
--form relationAttrCode=distinct_id
2.2 返回参数
字段 | 名称 | 类型 | 描述 |
---|---|---|---|
status | 接口响应状态码 | Integer | 成功=200 |
code | 业务响应编码 | String | 成功=0 |
message | 业务响应描述 | String | 操作成功 |
success | 接口成功标记 | Boolean | true 成功, false 失败 |
{
"status": 200,
"code": "0",
"message": null,
"success": true,
"data": null
}
三、错误码
接口响应状态码 | 接口响应状态码描述 | 业务响应编码 | 业务响应编码描述 |
---|---|---|---|
200 | 成功 | 0 | 成功 |
5001 | 业务异常 | API_KEY_EXPIRED | API_KEY已过期 |
5001 | 业务异常 | NOT_IN_IP_WHITE_LIST | IP白名单限制 |
5001 | 业务异常 | API_KEY_NOT_EXISTED | API_KEY不存在 |
5001 | 业务异常 | PROJECT_NOT_EXISTED | 项目不存在 |
5001 | 业务异常 | RELATION_ATTR_NOT_EXISTED | 关联属性不存在 |
5001 | 业务异常 | ANALYSIS_SUBJECT_NOT_EXISTED | 分析主体不存在 |
6001 | 参数验证异常 | PARAM_VERIFY_FAIL | 参数验证失败 |
{
"status": 5001,
"code": "NOT_IN_IP_WHITE_LIST",
"message": "IP白名单限制 [172.23.7.64]",
"success": false,
"data": null
}
{
"status": 5001,
"code": "PROJECT_NOT_EXISTED",
"message": "项目不存在",
"success": false,
"data": null
}
{
"status": 5001,
"code": "RELATION_ATTR_NOT_EXISTED",
"message": "关联属性不存在",
"success": false,
"data": null
}
{
"status": 5001,
"code": "ANALYSIS_SUBJECT_NOT_EXISTED",
"message": "分析主体不存在",
"success": false,
"data": null
}
作者:超级管理员 创建时间:2024-09-18 14:27
最后编辑:超级管理员 更新时间:2024-11-08 10:38
最后编辑:超级管理员 更新时间:2024-11-08 10:38