导出报表数据——数据看板
1.默认指标(新用户/老用户/事件量)
POST _SJK_API_PATH_/api-v2/dashboard/default_num
请求参数:
字段 | 格式 | 说明 | 是否必需 | 示例 |
---|---|---|---|---|
access_token | string | 通过oauth认证获取的token | 是 | |
platform_id | int | 平台id | 否 | web:1 H5:2 IOS:3 Android:4 微信小程序:5 |
type | string | 看板类型,数值/趋势图 | 是 | 数值:num 趋势图:timeseries |
granularity | string | 查询的时间粒度 | type=timeseries时必需 | month / day / hour |
name | string | 指标名称 | 是 | 新用户:new_visitor / 老用户:old_vistor / 事件量event |
time_range | array | 查询的时间范围 | 是 | 例:time_range[]=2019-08-06&time_range[]=2019-08-12 需要有起始时间和结束时间2个值且结束时间不能小于起始时间 |
调用示例(type=num):
curl -d 'access_token=_TOKEN_&na1&time_range[]=2019-08-11&type=num' https://a.geekdata.com/api-v2/dashboard/default_num
Response:
{
"status": 0,
"msg": {
"msg": "success",
"desc": ""
},
"data": [
"1492" //新访客人数
]
}
调用示例(type=timeseries):
curl -d 'access_token=_TOKEN_&time_range[]=2019-08-11&time_range[]=2019-08-11&type=timeseries&name=new_visitor&granularity=hour' https://a.geekdata.com/api-v2/dashboard/default_num
Response:
{
"status": 0,
"msg": {
"msg": "success",
"desc": ""
},
"data": [
[
"2019-08-11 00:00:00",//按小时时间粒度分组
"66" //当前时间粒度内新访客人数
],
[
"2019-08-11 01:00:00",
"41"
],
[
"2019-08-11 02:00:00",
"41"
],
[
"2019-08-11 03:00:00",
"54"
],
[
"2019-08-11 04:00:00",
"55"
],
[
"2019-08-11 05:00:00",
"29"
],
[
"2019-08-11 06:00:00",
"29"
],
[
"2019-08-11 07:00:00",
"31"
],
[
"2019-08-11 08:00:00",
"50"
],
[
"2019-08-11 09:00:00",
"61"
],
[
"2019-08-11 10:00:00",
"60"
],
[
"2019-08-11 11:00:00",
"83"
],
[
"2019-08-11 12:00:00",
"70"
],
[
"2019-08-11 13:00:00",
"71"
],
[
"2019-08-11 14:00:00",
"66"
],
[
"2019-08-11 15:00:00",
"96"
],
[
"2019-08-11 16:00:00",
"136"
],
[
"2019-08-11 17:00:00",
"82"
],
[
"2019-08-11 18:00:00",
"66"
],
[
"2019-08-11 19:00:00",
"70"
],
[
"2019-08-11 20:00:00",
"77"
],
[
"2019-08-11 21:00:00",
"85"
],
[
"2019-08-11 22:00:00",
"82"
],
[
"2019-08-11 23:00:00",
"84"
]
]
}}
2.非默认指标
POST _SJK_API_PATH_/api-v2/dashboard/default_num
请求参数:
字段 | 格式 | 说明 | 是否必需 | 示例 |
---|---|---|---|---|
access_token | string | 通过oauth认证获取的token | 是 | |
platform_id | int | 平台id | 否 | web:1 H5:2 IOS:3 Android:4 微信小程序:5 |
type | string | 看板类型,数值/趋势图 | 是 | 数值:num 趋势图:timeseries |
granularity | string | 查询的时间粒度 | type=timeseries时必需 | month / day / hour |
time_range | array | 查询的时间范围 | 是 | 例:time_range[]=2019-08-06&time_range[]=2019-08-12 需要有起始时间和结束时间2个值且结束时间不能小于起始时间 |
events | array | 指标信息 | 是 | 例:events[0][name]=DGA注册&events[0][fe_name]=signup&events[0][metrics][0][name]=event&events[0][metrics][0][op]= 所查询的指标为 “DGA注册”事件的次数 |
events数组详细参数
字段 | 格式 | 说明 |
---|---|---|
events[].name | string | 指标事件中文名称 |
events[].fe_name | string | 指标事件英文名称,可通过 base/events 获取 |
events[].metrics | array | 指标计算信息 |
events[].metrics[].name | string | 指标英文名称,可通过 base/event_params 获取 |
events[].metrics[].op | string | 指标计算方式,默认指标为null,可通过 base/event_params 获取 |
调用示例(type=num):
curl -d 'access_token=_TOKEN_&events[0][name]=DGA注册&events[0][fe_name]=signup&events[0][metrics][0][name]=event&events[0][metrics][0][op]=&time_range[]=2019-08-14&time_range[]=2019-08-14&type=num' https://a.geekdata.com/api-v2/dashboard/calculate
Response:
{
"status": 0,
"msg": {
"msg": "success",
"desc": ""
},
"data": [
"4" //“DGA注册”事件的人数
]
}
调用示例(type=timeseries):
curl -d 'access_token=_TOKEN_&events[0][name]=DGA注册&events[0][fe_name]=signup&events[0][metrics][0][name]=event&events[0][metrics][0][op]=&time_range[]=2019-08-14&time_range[]=2019-08-14&type=timeseries&granularity=hour' https://a.geekdata.com/api-v2/dashboard/calculate
Response:
{
"status": 0,
"msg": {
"msg": "success",
"desc": ""
},
"data": [
[
"2019-08-14 01:00:00", //按小时时间粒度分组
"1" //当前时间粒度内"DGA注册"事件的人数
],
[
"2019-08-14 09:00:00",
"1"
],
[
"2019-08-14 10:00:00",
"2"
]
]
}