一、LTV分析查询API
此API用于客户根据书签编号获取到相应LTV分析的结果查询
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/ltv-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/ltv-analysis-list \
--header 'Content-Type: application/json' \
--header 'hi-api-key: #K-xxx' \
--data '{
"projectCode": "projectCode",
"bookmarkId": 184xxxx7010
}'
2.2 返回参数
字段 |
名称 |
类型 |
描述 |
status |
接口响应状态码 |
Integer |
成功=200 |
code |
业务响应编码 |
String |
成功=0 |
message |
业务响应描述 |
String |
操作成功 |
success |
接口成功标记 |
Boolean |
true 成功, false 失败 |
data |
返回数据 |
List |
返回列表数据 |
字段 |
名称 |
类型 |
描述 |
analysis_name |
分析指标名称 |
String |
分析指标名称 |
pk_day |
时间 |
String |
时间 |
users_cnt |
总人数 |
Long |
总人数 |
LTV0 |
当日LTV |
Double |
当日LTV |
LTV1 |
第1天LTV |
Double |
第1天LTV |
LTV2 |
第2天LTV |
Double |
第2天LTV |
LTV3 |
第3天LTV |
Double |
第3天LTV |
LTV4 |
第4天LTV |
Double |
第4天LTV |
LTV5 |
第5天LTV |
Double |
第5天LTV |
LTV6 |
第6天LTV |
Double |
第6天LTV |
LTV7 |
第7天LTV |
Double |
第7天LTV |
LTV15 |
第15天LTV |
Double |
第15天LTV |
LTV30 |
第30天LTV |
Double |
第30天LTV |
LTV60 |
第60天LTV |
Double |
第60天LTV |
动态分组字段 |
分组字段 |
String |
多个分组就返回多个字段,如 event.event,event.event_time |
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": [
{
"event.event": "H_pageview",
"event.event_time": "2024-11-12",
"pk_day": "2024-11-12",
"users_cnt": 1,
"LTV0": -37440.00,
"LTV1": -37440.00,
"LTV2": -37440.00,
"LTV3": -37440.00,
"LTV4": -37440.00,
"LTV5": -37440.00,
"LTV6": -37440.00,
"LTV7": -37440.00,
"LTV15": null,
"LTV30": null,
"LTV60": null,
"analysis_name": "Web 浏览页面.时区"
}
]
}
三、错误码
接口响应状态码 |
接口响应状态码描述 |
业务响应编码 |
业务响应编码描述 |
200 |
成功 |
0 |
成功 |
5001 |
业务异常 |
API_SERVICE_FAIL |
查询参数缺失 |
5001 |
业务异常 |
API_PROCESS_FAIL |
查询引擎发生错误 |
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
}
四、限制
类型 |
调用限制 |
描述 |
普通用户 |
QPS:2次/秒 |
接口限制 |
作者:超级管理员 创建时间:2024-11-22 15:35
最后编辑:梁松竹 更新时间:2025-01-21 14:17