数据接口
应用及渠道的所有统计数据,均以HTTP接口的形式向开发者开放,开发者可通过这些数据接口抓取数据自行存储,或做报表二次开发。
接口配置
请开发者注册并登录openinstall后台,找到【数据接口】-【接口配置】,开启数据接口开关等配置。
接口规范
1.渠道创建
接口介绍
接口描述:通过指定渠道编号、名称等来创建新的H5渠道,若渠道编号已存在则修改已有渠道信息
接口地址:https://data.openinstall.io/data/channel/add
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
channelCode | 字符串;渠道编号,若渠道编号不存在,则新增渠道,反之修改渠道 |
channelName | 字符串;渠道名称 |
customURL | 字符串,可选;自定义落地页URL |
groupName | 字符串,可选;渠道分组名称 |
JSON返回示例
{
"code": 0,
"error": null,
"body": null
}
2.渠道列表
接口介绍
接口描述:通过执行查询条件,返回H5渠道列表信息数据,支持分页
接口地址:https://data.openinstall.io/data/channel/list
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
pageNum | 整形数字,页数,从0开始;当前第几页 |
pageSize | 整形数字,100以内,默认10;每页总数 |
sortField | 字符串,可选值createTime/channelCode/channelName,默认为createTime;排序字段 |
asc | 是否正序排序,可选值:0/1;默认0;倒序/正序 |
search | 字符串,可选;渠道编号或者渠道名称 |
结果行参数
参数名 | 说明 |
---|---|
channelCode | 字符串;渠道编号 |
channelName | 字符串;渠道名称 |
linkUrl | 字符串;落地页地址 |
createTime | 字符串;创建日期,返回ISO标准时间格式:yyyy-MM-dd'T'HH:mm:ss.SSSZ; |
groupName | 字符串;分组名称 |
JSON返回示例
{
"code": 0,
"error": null,
"body": [
{"channelCode":"liu666","channelName":"小明测试","linkUrl":"https://app-3rqhu6.openinstall.io/page/3rqhu6/channel-landing?channelCode=liu666","createTime":"2019-08-06T21:18:43.027+0800","groupName":"默认分组"},
{"channelCode":"op-1","channelName":"线下门面广告","linkUrl":"https://app-3rqhu6.openinstall.io/page/3rqhu6/channel-landing?channelCode=op-1","createTime":"2019-07-19T09:38:11.567+0800","groupName":"默认分组"},
{"channelCode":"allen","channelName":"线上广告投放-1","linkUrl":"https://app-3rqhu6.openinstall.io/page/3rqhu6/channel-landing?channelCode=allen","createTime":"2019-07-18T16:20:52.591+0800","groupName":"默认分组"}
],
"pageInfo": {
"total": 13,
"hasNext": true,
"hasPrev": true,
"pages": 5,
"pageNum": 2
}
}
3.新增安装数据
接口介绍
接口描述:通过指定一个时间范围,返回这段时间内新增的安装量,注册量,以及这些新增安装中在1/7/30天后的留存数;统计口径包含:按天统计/按小时统计/合计
接口地址:https://data.openinstall.io/data/event/growth
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
channelCode | 渠道编号,可选;当指定渠道编号时,返回这个渠道的数据,否则返回整个应用的数据 |
platform | 平台过滤,可选值:android/ios,默认为android |
beginDate | 查询的开始日期,包含当天,默认为应用创建日期,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
endDate | 查询的截止日期,不包含当天,默认为下一个自然日,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
groupBy | 可选值:day/hour/sum,默认为day;分别表示按天统计/按小时统计/合计 |
excludeDuplication | 是否排除重复安装的数据,可选值:0/1,默认为0;分别表示:不排重/排重 |
结果行参数
参数名 | 说明 |
---|---|
date | 字符串;日期,返回ISO标准时间格式:yyyy-MM-dd'T'HH:mm:ss.SSSZ;当groupBy=sum时,返回空 |
visit | 整形数字;落地页的访问数 |
click | 整形数字;落地页的点击数 |
install | 整形数字;安装数 |
register | 整形数字;注册数 |
survive_d1 | 整形数字;1天后的留存数 |
survive_d7 | 整形数字;7天后的留存数 |
survive_d30 | 整形数字;30天后的留存数 |
JSON返回示例
{
"code": 0,
"error": null,
"body": [
{"date":"2021-02-18T00:00:00.000+0800","visit":230,"click":140,"install":74,"register":30,"survive_d1":22,"survive_d7":14,"survive_d30":9},
{"date":"2021-02-19T00:00:00.000+0800","visit":375,"click":197,"install":115,"register":68,"survive_d1":58,"survive_d7":32,"survive_d30":18}
]
}
4.活跃数据
接口介绍
接口描述:通过指定一个时间范围,返回这段时间内的活跃设备数,活跃用户数,打开次数,在线时长;统计口径包含:按天统计/按小时统计/合计
接口地址:https://data.openinstall.io/data/event/active
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
channelCode | 渠道编号,可选;当指定渠道编号时,返回这个渠道的数据,否则返回整个应用的数据 |
platform | 平台过滤,可选值:android/ios,默认为android |
beginDate | 查询的开始日期,包含当天,默认为应用创建日期,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
endDate | 查询的截止日期,不包含当天,默认为下一个自然日,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
groupBy | 可选值:day/hour/sum,默认为day;分别表示按天统计/按小时统计/合计 |
结果行参数
参数名 | 说明 |
---|---|
date | 字符串;日期,返回ISO标准时间格式:yyyy-MM-dd'T'HH:mm:ss.SSSZ;当groupBy=sum时,返回空 |
device | 整形数字;活跃设备数 |
user | 整形数字;活跃用户数 |
count | 整形数字;活跃总次数 |
duration | 整形数字;活跃总时长,单位为秒 |
JSON返回示例
{
"code": 0,
"error": null,
"body": [
{"date":"2021-03-01T00:00:00.000+0800","device":5,"user":0,"count":16,"duration":982},
{"date":"2021-03-02T00:00:00.000+0800","device":8,"user":0,"count":36,"duration":6581},
{"date":"2021-03-03T00:00:00.000+0800","device":5,"user":0,"count":14,"duration":1171},
{"date":"2021-03-04T00:00:00.000+0800","device":1,"user":0,"count":1,"duration":2},
]
}
5.效果点数据
接口介绍
接口描述:通过指定一个时间范围以及自定义的效果点ID,返回这段时间内这个效果点的累计值与独立设备数;统计口径包含:按天统计/按小时统计/合计
接口地址:https://data.openinstall.io/data/event/custom
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
channelCode | 渠道编号,可选;当指定渠道编号时,返回这个渠道的数据,否则返回整个应用的数据 |
platform | 平台过滤,可选值:android/ios,默认为android |
beginDate | 查询的开始日期,包含当天,默认为应用创建日期,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
endDate | 查询的截止日期,不包含当天,默认为下一个自然日,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
groupBy | 可选值:day/hour/sum,默认为day;分别表示按天统计/按小时统计/合计 |
eventCode | 自定义效果点的ID |
结果行参数
参数名 | 说明 |
---|---|
date | 字符串;日期,返回ISO标准时间格式:yyyy-MM-dd'T'HH:mm:ss.SSSZ;当groupBy=sum时,返回空 |
eventValue | 整形数字;效果点的累计值 |
device | 整形数字;独立设备数 |
JSON返回示例
{
"code": 0,
"error": null,
"body": [
{"date":"2021-03-23T00:00:00.000+0800","eventValue":2,"device":1},
{"date":"2021-03-24T00:00:00.000+0800","eventValue":2,"device":2},
{"date":"2021-03-25T00:00:00.000+0800","eventValue":2,"device":2}
]
}
6.活跃设备分布
接口介绍
接口描述:指定过去某个时间点,返回这个时间点在(当天/过去7天内/过去30天内)有过活跃记录的设备分组统计数据;分组方式包括:系统版本/app版本/机型/国家/省份/总量
接口地址:https://data.openinstall.io/data/sum/live
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
channelCode | 渠道编号,可选;当指定渠道编号时,返回这个渠道的数据,否则返回整个应用的数据 |
platform | 平台过滤,可选值:android/ios,默认为android |
date | 日期,默认为当天;格式为yyyy-MM-dd,如:2020-01-01 |
type | 对活跃设备的判断依据,可选值:d0/d7/d30,默认为d0;分别表示:当天有活跃/过去7天内有活跃/过去30天内有活跃 |
sumBy | 分组方式,可选值:system_version/app_version/brand_model/country/state/total,默认为total;分别表示:系统版本/app版本/机型/国家/省份/总量 |
结果行参数
参数名 | 说明 |
---|---|
key | 字符串;分组统计的key,具体意义与sumBy对应 |
value | 整形数字;设备总数 |
JSON返回示例
{
"code": 0,
"error": null,
"body": [
{"key":"1.0.3","value":31},
{"key":"1.0.4","value":11},
{"key":"1.0.1","value":1}
]
}
7.新增设备分布
接口介绍
接口描述:通过指定一个时间范围,返回这段时间内新增的设备分组统计数据;分组方式包括:系统版本/app版本/机型/国家/省份/总量
接口地址:https://data.openinstall.io/data/sum/growth
请求方式: GET
请求参数
参数名 | 说明 |
---|---|
apiKey | 平台自动为每个应用单独分配的唯一标识符,可在接口配置中查看 |
channelCode | 渠道编号,可选;当指定渠道编号时,返回这个渠道的数据,否则返回整个应用的数据 |
platform | 平台过滤,可选值:android/ios,默认为android |
beginDate | 查询的开始日期,包含当天,默认为应用创建日期,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
endDate | 查询的截止日期,不包含当天,默认为下一个自然日,查询的时间跨度不能超过30天;格式为yyyy-MM-dd,如:2020-01-01 |
excludeDuplication | 是否排除重复安装的数据,可选值:0/1,默认为0;分别表示:不排重/排重 |
sumBy | 可选值:system_version/app_version/brand_model/country/state/total,默认为total;分别表示:系统版本/app版本/机型/国家/省份/总量 |
结果行参数
参数名 | 说明 |
---|---|
key | 字符串;分组统计的key,具体意义与sumBy对应 |
value | 整形数字;设备总数 |
JSON返回示例
{
"code": 0,
"error": null,
"body": [
{"key":"total","value":118}
]
}