1. 开放API
1.1. 对外数据API
调用方法：
提供数据API服务的地址为https://hubble.netease.com/api/，每一个调用请求需在请求头部内容中传入AccessKey作为认证信息，AccessKey在哈勃产品页面的应用管理->查看AccessKey中获取。
响应内容分为code、message、data。code为服务状态码，message为服务状态信息，data为数据结果；调用方可根据code的值选择对应的后续行为，状态码及其解释见服务响应列表。
1.2. API实例
1.2.1. 概览【Post /data/summary/query】
请求：
curl 'https://hubble.netease.com/api/data/summary/query' \
-H 'Content-Type: application/json' \
-H "AccessKey: 2963d35cb2bf51d1" \
-X POST \
-d
'{
"name": "totalUser",
"appkey": "Web",
"fromDate": "2017-10-12",
"toDate": "2017-10-18",
"type": "user"
}'
响应：
{
"code": 200,
"message": "成功",
"data": {
"avg": "207762",
"values": [
"{\"2017-10-12\":{\"value\":\"202999\",\"pre\":\"197468\"}}",
"{\"2017-10-13\":{\"value\":\"203834\",\"pre\":\"198236\"}}",
"{\"2017-10-14\":{\"value\":\"204591\",\"pre\":\"198980\"}}",
"{\"2017-10-15\":{\"value\":\"205376\",\"pre\":\"199826\"}}",
"{\"2017-10-16\":{\"value\":\"206169\",\"pre\":\"200603\"}}",
"{\"2017-10-17\":{\"value\":\"206913\",\"pre\":\"201450\"}}",
"{\"2017-10-18\":{\"value\":\"207762\",\"pre\":\"202236\"}}"
],
"ratio": "2.78%",
"setAvg": true,
"valuesSize": 7,
"valuesIterator": [
"{\"2017-10-12\":{\"value\":\"202999\",\"pre\":\"197468\"}}",
"{\"2017-10-13\":{\"value\":\"203834\",\"pre\":\"198236\"}}",
"{\"2017-10-14\":{\"value\":\"204591\",\"pre\":\"198980\"}}",
"{\"2017-10-15\":{\"value\":\"205376\",\"pre\":\"199826\"}}",
"{\"2017-10-16\":{\"value\":\"206169\",\"pre\":\"200603\"}}",
"{\"2017-10-17\":{\"value\":\"206913\",\"pre\":\"201450\"}}",
"{\"2017-10-18\":{\"value\":\"207762\",\"pre\":\"202236\"}}"
],
"setValues": true,
"setRatio": true
}
}
参数说明
- type: 数值量度
- "user":用户
- "deivce":设备
- name: 指标类型。取值内容见概览参数列表;
- appkey: 应用名称。查询移动应用数据时，值为"mobile"
1.2.2. 用户分群列表【GET /data/user_group/list】
请求：
curl 'https://hubble.netease.com/api/data/user_group/list' \
-H 'AccessKey: 2963d35cb2bf51d1'
响应：
{
"code": 200,
"message": "成功",
"data": [
{
"name": "测试1234",
"count": 539201
},
{
"name": "测试分群",
"count": 0
}
]
}
参数说明
- name：分群名称
- count：分群当前计算结果
1.2.3. 用户分群明细【GET /data/user_group/details】
请求：
curl 'https://hubble.netease.com/api/data/user_group/details?userGroupName=购买成功用户' \
-H 'AccessKey: 2963d35cb2bf51d1'
响应：
{
"code": 200,
"message": "成功",
"data": "http://nos.netease.com/hubbledatabucket/css1_1508742578812.csv?Signature=ervvq3zgR8KMxIGl0UYzJOdkiu6IMoH3KaQnrw%2BW8TA%3D&Expires=1508828979&NOSAccessKeyId=6daf9662f1fb4e8298a64908487d3df4"
}
参数说明
- userGroupName：用户分群名称
- data：data中url是用户分群详细结果的CSV下载地址，调用方须再次请求该地址进行数据下载
1.2.4. 概览参数列表
| 指标名称 | 具体内容 | 参数标识 |
|---|---|---|
| 日均活跃用户数 | 一段时间内，平均每天访问网站的用户数（每日去重用户数加总除以天数，天之间不去重） | activeUser |
| 日均新增用户数 | 一段时间内，平均每天首次访问网站的用户数（cookie新增） | newUser |
| 累积用户数（网页端） | 截止所选时间终止日期，产品的累计去重用户数（选择5/1至6/1时，累积用户数取6/1号的数据，包含各天累计用户数） | totalUser |
| 日均浏览量（网页端） | 一段时间内，平均每天网页访问量（pv） | pageView |
| 日均访问量（网页端） | 一段时间内，平均每天网站被访问的会话次数（session） | sessionCnt |
| 日均跳出率（网页端） | 一段时间内，只浏览一个页面的访问次数占所有访问次数的百分比 | bounceRate |
| 访问时长(分钟)（网页端） | 一段时间内，平均每次访问网站的浏览时间（总的访问时间除以总的会话次数） | usetime |
| 访问深度（网页端） | 一段时间内，平均每次访问网站的页面浏览量（网站总的页面访问量除以总的会话次数） | avgVisitLen |
| 新增用户次日留存率 | 一段时间内，第2天仍然访问网站的用户数占首次访问网站的比例 | retained |
| 新增用户留存率趋势图 | 一段时间内，新增用户数中仍然访问网站的用户占比随着时间的变化趋势 | retentionTrend |
| 入口页面Top10（网页端） | 入口页面：网站每次回话中第一个页面；跳出率：该页面作为入口页面并且只有一次访问的回话次数除以该页面作为入口页面的总的访问次数 | firstPageNewUser(新增用户)/firstPageActiveUser(活跃用户) |
| 页面浏览Top10（网页端） | 一段时间内，浏览量最大的前10个页面，以及这些页面占总体浏览量的比例 | webPageNewUser/webPageActiveUser |
| 访问城市Top10 | 一段时间，访问用户数最多的前10个城市 | cityNewUser(新增用户)/cityActiveUser(活跃用户) |
| 网站来源Top10（网页端） | 一段时间，来源最多的前10个网站 | referrerNewUser(新增用户)/referrerActiveUser(活跃用户) |
| 日均人均启动次数（移动端） | 一段时间内，平均每个用户每日启动应用的次数（应用总启动次数除以总的用户数） | avgTimes |
| 页面访问Top10（移动端） | 一段时间内，启动最多的前10个页面以及这些页面占总体的比 | pageNewUser(新增用户)/pageActiveUser(活跃用户) |
| 事件触发Top10（移动端） | 一段时间内，触发最多的前10个自定义事件以及这些事件占整体的比例 | eventNewUser(新增用户)/eventActiveUser(活跃用户) |
| 设备型号Top10（移动端） | 一段时间内，使用应用用户最多的前10个设备 | devicemodelNewUser(新增用户)/devicemodelActiveUser(活跃用户) |
| APP版本Top10（移动端） | 一段时间内，使用用户最多的前10个应用版本 | appversionNewUser(新增用户)/appversionActiveUser(活跃用户) |
| 渠道来源Top10（移动端） | 一段时间内，使用应用最多的前10个应用渠道 | appchannelNewUser(新增用户)/appchannelActiveUser(活跃用户) |
1.2.5. 服务响应列表
| 状态码 | 状态详细 |
|---|---|
| 200 | 成功 |
| 501 | 查询服务器通信异常 |
| 502 | 数据计算中 |
| 401 | 校验信息错误 |
| 503 | 系统当前查询请求较多 |
| 404 | 查询无数据 |
| 504 | 任务计算失败请重新提交任务 |
| 402 | 参数缺失 |
| 403 | 参数有误 |