一、漏斗分析下载API

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

二、调用方法

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

2.2 返回参数

字段 名称 类型 描述
status 接口响应状态码 Integer 成功=200
code 业务响应编码 String 成功=0
message 业务响应描述 String 操作成功
success 接口成功标记 Boolean true 成功， false 失败
data 返回数据 List 返回列表数据
字段 名称 类型 描述
pk_day 时间 String 指标时间
total_conversion_rate 总转化率 Integer 总转化率
total_churn_rate 总流失率 Integer 总流失率
total_lost_users 总流失用户数 Integer 总流失用户数
step(n) 步骤数 Integer 例如：step1，step2
sum_conversion_rate_step(n) 累计转化率（步骤数） Integer 例如：累计转化率（步骤2） sum_conversion_rate_step2
churn_rate_step(n_n+1)) 流失率（步骤n到步骤n+1） Integer 例如：流失率（步骤1到步骤2）churn_rate_step1_2
lost_users_step(n_n+1)) 流失用户数（步骤n到步骤n+1） Integer 例如：流失用户数（步骤1到步骤2）lost_users_step1_2
event.xxx 事件属性分组字段 String 有分组项时存在，例如：event.event_time
users.xxx 用户属性分组字段 String 有分组项时存在，例如：users.user_name
catalog_tag.xxx 用户标签分组字段 String 有分组项时存在，例如：catalog_tag.feature_20220112_147
catalog_cluster.xxx 用户分群分组字段 String 有分组项时存在，例如：catalog_cluster.cluster_20220124_746 
{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": [
        {
            "catalog_cluster.cluster_20241024_493": null,
            "step4": 0,
            "users.H_city": null,
            "sum_conversion_rate_step4": 0,
            "churn_rate_step3_4": 0,
            "sum_conversion_rate_step2": 0,
            "lost_users_step1_2": 1,
            "sum_conversion_rate_step3": 0,
            "lost_users_step2_3": 0,
            "lost_users_step3_4": 0,
            "event.event": null,
            "step2": 0,
            "step3": 0,
            "step1": 1,
            "catalog_tag.feature_20240913_775": null,
            "pk_day": "总体",
            "total_churn_rate": 1,
            "churn_rate_step1_2": 1,
            "churn_rate_step2_3": 0,
            "total_conversion_rate": 0,
            "total_lost_users": 1
        },
        {
            "catalog_cluster.cluster_20241024_493": null,
            "step4": 0,
            "users.H_city": null,
            "sum_conversion_rate_step4": 0,
            "churn_rate_step3_4": 0,
            "sum_conversion_rate_step2": 0,
            "lost_users_step1_2": 1,
            "sum_conversion_rate_step3": 0,
            "lost_users_step2_3": 0,
            "lost_users_step3_4": 0,
            "event.event": null,
            "step2": 0,
            "step3": 0,
            "step1": 1,
            "catalog_tag.feature_20240913_775": null,
            "pk_day": "2024-11-04",
            "total_churn_rate": 1,
            "churn_rate_step1_2": 1,
            "churn_rate_step2_3": 0,
            "total_conversion_rate": 0,
            "total_lost_users": 1
        },
        {
            "catalog_cluster.cluster_20241024_493": "不属于分群_20241024_493",
            "step4": 0,
            "users.H_city": "(null)",
            "sum_conversion_rate_step4": 0,
            "churn_rate_step3_4": 0,
            "sum_conversion_rate_step2": 0,
            "lost_users_step1_2": 1,
            "sum_conversion_rate_step3": 0,
            "lost_users_step2_3": 0,
            "lost_users_step3_4": 0,
            "event.event": "H_pageview",
            "step2": 0,
            "step3": 0,
            "step1": 1,
            "catalog_tag.feature_20240913_775": "(null)",
            "pk_day": "2024-11-04",
            "total_churn_rate": 1,
            "churn_rate_step1_2": 1,
            "churn_rate_step2_3": 0,
            "total_conversion_rate": 0,
            "total_lost_users": 1
        },
        {
            "catalog_cluster.cluster_20241024_493": "不属于分群_20241024_493",
            "step4": 0,
            "users.H_city": "(null)",
            "sum_conversion_rate_step4": 0,
            "churn_rate_step3_4": 0,
            "sum_conversion_rate_step2": 0,
            "lost_users_step1_2": 1,
            "sum_conversion_rate_step3": 0,
            "lost_users_step2_3": 0,
            "lost_users_step3_4": 0,
            "event.event": "H_pageview",
            "step2": 0,
            "step3": 0,
            "step1": 1,
            "catalog_tag.feature_20240913_775": "(null)",
            "pk_day": "2024-11-08",
            "total_churn_rate": 1,
            "churn_rate_step1_2": 1,
            "churn_rate_step2_3": 0,
            "total_conversion_rate": 0,
            "total_lost_users": 1
        }
    ]
}

三、错误码

接口响应状态码 接口响应状态码描述 业务响应编码 业务响应编码描述
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-11 14:21
最后编辑：梁松竹  更新时间：2024-11-20 17:38