一、属性分析下载API

此API用于客户根据书签编号获取到相应属性分析的下载结果

二、调用方法

API URL: https://higateway.haishuu.com/gateway/hi-api/v1/attribute-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/attribute-analysis-list \
  --header 'Content-Type: application/json' \
  --header 'hi-api-key: #K-xxx' \
  --data '{
    "projectCode": "projectCode",
    "bookmarkId": 185xxxxxxxx8241
}'

2.2 返回参数

字段 名称 类型 描述
status 接口响应状态码 Integer 成功=200
code 业务响应编码 String 成功=0
message 业务响应描述 String 操作成功
success 接口成功标记 Boolean true 成功， false 失败
data 返回数据 List 返回列表数据
字段 名称 类型 描述
calres 计算结果 Long 属性分析指标统计结果
bins.分组属性编码 第一个分组属性列 String 有分组项存在，第一个分组属性
bins 第二及以后多个分组属性列 String 有分组项存在，第二及以后分组属性组合列 结果逗号分隔 例如：中国,上海市
cluster_name 人群对比 String 有人群对比存在

无分组：

{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": [
        {
            "calres": 998
        }
    ]
}

单分组 城市：

{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": [
        {
            "calres": 1,
            "bins.H_city": "上海市",
            "bins": "上海市"
        }
    ]
}

多分组 城市,姓名,年龄：

{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": [
        {
            "calres": 1,
            "bins.H_city": "上海市",
            "bins": "上海市,薛xx,28"
        }
    ]
}

人群对比：

{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": [
        {
            "calres": 14,
            "cluster_name": "人群1"
        },
        {
            "calres": 231,
            "cluster_name": "人群2"
        },
        {
            "calres": 32,
            "cluster_name": "人群3"
        }
    ]
}

三、错误码

接口响应状态码 接口响应状态码描述 业务响应编码 业务响应编码描述
200 成功 0 成功
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
}
作者：梁松竹  创建时间：2024-11-05 16:05
最后编辑：梁松竹  更新时间：2024-11-12 16:36