数据接口

应用及渠道的所有统计数据，均以HTTP接口的形式向开发者开放，开发者可通过这些数据接口抓取数据自行存储，或做报表二次开发。

接口配置

请开发者注册并登录openinstall后台，找到【数据接口】-【接口配置】，开启数据接口开关等配置。

接口规范

1.渠道分组列表
2.渠道分组创建
3.渠道分组修改
4.渠道分组删除
5.渠道创建/修改
6.渠道详情
7.渠道列表
8.渠道删除
9.子渠道列表
10.子渠道新增
11.子渠道修改
12.子渠道删除
13.新增安装数据
14.存量设备数据
15.活跃数据
16.效果点数据
17.存量设备分布
18.新增设备分布

1.渠道分组列表

接口介绍

接口描述：返回当前应用下所有的渠道分组，每个应用均存在一个默认的分组(default)，所有未指定分组的渠道均归属于默认分组，默认分组无法修改，无法删除
接口地址：https://data.openinstall.io/data/group/list
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看

结果行参数

参数名说明
groupName字符串；渠道分组名称

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": [
        {"groupName":"default"},
        {"groupName":"巨量"},
        {"groupName":"百度OCPC"},
        {"groupName":"分享"}
    ]
}

2.渠道分组创建

接口介绍

接口描述：创建新的渠道分组，若分组名冲突则返回错误；最多可创建30个分组
接口地址：https://data.openinstall.io/data/group/add
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
groupName字符串；渠道分组名称

结果行参数

参数名说明
groupName字符串；渠道分组名称

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": {
        "groupName": "广告B"
    }
}

3.渠道分组修改

接口介绍

接口描述：修改渠道分组
接口地址：https://data.openinstall.io/data/group/update
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
groupName字符串；渠道分组名称
newGroupName字符串；修改后新的渠道分组名称

结果行参数

参数名说明
groupName字符串；渠道分组名称

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": {
        "groupName": "广告C"
    }
}

4.渠道分组删除

接口介绍

接口描述：删除渠道分组，下属渠道全部进入默认分组
接口地址：https://data.openinstall.io/data/group/delete
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
groupName字符串；渠道分组名称

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": null
}

5.渠道创建/修改

接口介绍

接口描述：通过指定渠道编号、名称等来创建新的H5渠道，若渠道编号已存在则修改已有渠道信息
接口地址：https://data.openinstall.io/data/channel/add
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
channelCode字符串，必填；channelCode已存在表示修改渠道；反之表示创建新的渠道
channelName字符串，必填；渠道名称
customURL字符串，可选；自定义落地页URL，为空时表示使用系统默认的落地页
groupName字符串，可选；渠道分组名称
allowChild是否可创建子渠道，仅创建新的渠道时可用，可选值：0/1；默认0
sharePrivate报表分享页是否需要密码保护，可选值：0/1；默认1
sharePassword字符串，报表分享页的密码；默认使用系统自动生成的随机密码

结果行参数

参数名说明
channelCode字符串；渠道编号
channelName字符串；渠道名称
customURL字符串；自定义落地页URL，为空时表示使用系统默认的落地页
linkUrl字符串；渠道发布地址，即在落地页URL后添加channelCode参数
createTime字符串；创建日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
allowChild布尔值；是否可创建子渠道
shareUrl字符串；报表分享页地址
sharePrivate布尔值；报表分享页是否需要密码保护
sharePassword字符串；报表分享页的密码
groupName字符串；分组名称

JSON返回示例

{
"code": 0,
    "error": null,
    "body": {
        "channelCode": "001",
        "channelName": "广告001",
        "customUrl": null,
        "linkUrl": "https://app-i469do.openinstall.io/page/i469do/channel-landing?channelCode=001",
        "createTime": "2022-04-18T16:07:35.102+0800",
        "allowChild": false,
        "shareUrl": "https://report.openinstall.io/channel/1095401724/625d1c47a41fc481e33ceb9d",
        "sharePrivate": true,
        "sharePassword": "mKfFOb",
        "groupName": "广告C"
    }
}

6.渠道详情

接口介绍

接口描述：通过指定渠道编号精确查找渠道数据，返回单个H5渠道的详细信息
接口地址：https://data.openinstall.io/data/channel/get
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
channelCode字符串，必填；渠道编号

结果行参数

参数名说明
channelCode字符串；渠道编号
channelName字符串；渠道名称
customURL字符串；自定义落地页URL，为空时表示使用系统默认的落地页
linkUrl字符串；渠道发布地址，即在落地页URL后添加channelCode参数
createTime字符串；创建日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
allowChild布尔值；是否可创建子渠道
shareUrl字符串；报表分享页地址
sharePrivate布尔值；报表分享页是否需要密码保护
sharePassword字符串；报表分享页的密码
groupName字符串；分组名称

JSON返回示例

{
"code": 0,
    "error": null,
    "body": {
        "channelCode": "001",
        "channelName": "广告001",
        "customUrl": null,
        "linkUrl": "https://app-i469do.openinstall.io/page/i469do/channel-landing?channelCode=001",
        "createTime": "2022-04-18T16:07:35.102+0800",
        "allowChild": false,
        "shareUrl": "https://report.openinstall.io/channel/1095401724/625d1c47a41fc481e33ceb9d",
        "sharePrivate": true,
        "sharePassword": "mKfFOb",
        "groupName": "广告C"
    }
}

7.渠道列表

接口介绍

接口描述：通过执行查询条件，返回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字符串，可选；渠道编号或者渠道名称
groupName字符串，可选；渠道分组名称

结果行参数

参数名说明
channelCode字符串；渠道编号
channelName字符串；渠道名称
customURL字符串；自定义落地页URL，为空时表示使用系统默认的落地页
linkUrl字符串；渠道发布地址，即在落地页URL后添加channelCode参数
createTime字符串；创建日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
allowChild布尔值；是否可创建子渠道
shareUrl字符串；报表分享页地址
sharePrivate布尔值；报表分享页是否需要密码保护
sharePassword字符串；报表分享页的密码
groupName字符串；分组名称

JSON返回示例

{
"code": 0,
    "error": null,
    "body": [
        {"channelCode":"001","channelName":"广告001","customUrl":null,"linkUrl":"https://app-i469do.openinstall.io/page/i469do/channel-landing?channelCode=001","createTime":"2022-04-18T16:07:35.102+0800","allowChild":false,"shareUrl":"https://report.openinstall.io/channel/1095401724/625d1c47a41fc481e33ceb9d","sharePrivate":true,"sharePassword":"mKOfFb","groupName":"广告C"}
    ],
    "pageInfo": {
        "total": 1,
        "hasNext": false,
        "hasPrev": false,
        "pages": 1,
        "pageNum": 0
    }
}

8.渠道删除

接口介绍

接口描述：通过指定渠道编号来删除H5渠道
接口地址：https://data.openinstall.io/data/channel/delete
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
channelCode字符串数组；渠道编号，支持同时删除多个渠道

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": null
}

9.子渠道列表

接口介绍

接口描述：通过指定父渠道编号，查询下属的子渠道列表，支持分页
接口地址：https://data.openinstall.io/data/channel/child/list
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
pageNum整形数字，页数，从0开始；当前第几页
pageSize整形数字，100以内，默认10；每页总数
sortField字符串，可选值createTime/channelCode/channelName，默认为createTime；排序字段
asc是否正序排序，可选值：0/1；默认0；倒序/正序
parentChannelCode字符串，必填；父渠道编号

结果行参数

参数名说明
channelCode字符串；渠道编号
channelName字符串；渠道名称
customURL字符串；自定义落地页URL，为空时表示使用系统默认的落地页
linkUrl字符串；渠道发布地址，即在落地页URL后添加channelCode参数
createTime字符串；创建日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
allowChild布尔值；是否可创建子渠道
shareUrl字符串；报表分享页地址
sharePrivate布尔值；报表分享页是否需要密码保护
sharePassword字符串；报表分享页的密码
parentChannelCode字符串；父渠道编号

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": [
        {"channelCode":"001*1","channelName":"child001","customUrl":null,"linkUrl":"https://app-i469do.openinstall.io/page/i469do/channel-landing?channelCode=001*1","createTime":"2022-04-18T16:37:25.482+0800","allowChild":false,"shareUrl":"https://report.openinstall.io/channel/1095401724/625d2345a41fc481e354d821","sharePrivate":true,"sharePassword":"654321","parentChannelCode":"001"}
    ],
    "pageInfo": {
        "total": 1,
        "hasNext": false,
        "hasPrev": false,
        "pages": 1,
        "pageNum": 0
    }
}

10.子渠道新增

接口介绍

接口描述：通过指定父渠道编号，新增一个下属子渠道
接口地址：https://data.openinstall.io/data/channel/child/add
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
parentChannelCode字符串，必填；父渠道编号
channelName字符串，必填；子渠道名称
sharePrivate报表分享页是否需要密码保护，可选值：0/1；默认1
sharePassword字符串，报表分享页的密码；此字段不存在时，使用默认的随机密码，提供空字符串时表示取消密码访问限制

结果行参数

参数名说明
channelCode字符串；渠道编号
channelName字符串；渠道名称
customURL字符串；自定义落地页URL，为空时表示使用系统默认的落地页
linkUrl字符串；渠道发布地址，即在落地页URL后添加channelCode参数
createTime字符串；创建日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
allowChild布尔值；是否可创建子渠道
shareUrl字符串；报表分享页地址
sharePrivate布尔值；报表分享页是否需要密码保护
sharePassword字符串；报表分享页的密码
parentChannelCode字符串；父渠道编号

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": {
        "channelCode": "001*1",
        "channelName": "child001",
        "customUrl": null,
        "linkUrl": "https://app-i469do.openinstall.io/page/i469do/channel-landing?channelCode=001*1",
        "createTime": "2022-04-18T16:37:25.482+0800",
        "allowChild": false,
        "shareUrl": "https://report.openinstall.io/channel/1095401724/625d2345a41fc481e354d821",
        "sharePrivate": true,
        "sharePassword": "654321",
        "parentChannelCode": "001"
    }
}

11.子渠道修改

接口介绍

接口描述：通过指定父渠道编号，修改一个下属子渠道
接口地址：https://data.openinstall.io/data/channel/child/update
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
parentChannelCode字符串，必填；父渠道编号
channelCode字符串，必填；子渠道编号
channelName字符串，必填；子渠道名称
sharePrivate报表分享页是否需要密码保护，可选值：0/1；默认1
sharePassword字符串，报表分享页的密码；此字段不存在时，使用默认的随机密码，提供空字符串时表示取消密码访问限制

结果行参数

参数名说明
channelCode字符串；渠道编号
channelName字符串；渠道名称
customURL字符串；自定义落地页URL，为空时表示使用系统默认的落地页
linkUrl字符串；渠道发布地址，即在落地页URL后添加channelCode参数
createTime字符串；创建日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
allowChild布尔值；是否可创建子渠道
shareUrl字符串；报表分享页地址
sharePrivate布尔值；报表分享页是否需要密码保护
sharePassword字符串；报表分享页的密码
parentChannelCode字符串；父渠道编号

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": {
        "channelCode": "001*1",
        "channelName": "child001",
        "customUrl": null,
        "linkUrl": "https://app-i469do.openinstall.io/page/i469do/channel-landing?channelCode=001*1",
        "createTime": "2022-04-18T16:37:25.482+0800",
        "allowChild": false,
        "shareUrl": "https://report.openinstall.io/channel/1095401724/625d2345a41fc481e354d821",
        "sharePrivate": true,
        "sharePassword": "654321",
        "parentChannelCode": "001"
    }
}

12.子渠道删除

接口介绍

接口描述：通过指定父渠道编号，修改一个下属子渠道
接口地址：https://data.openinstall.io/data/channel/child/delete
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
parentChannelCode字符串，必填；父渠道编号
channelCode字符串，必填；子渠道编号

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": null
}

13.新增安装数据

接口介绍

接口描述：通过指定一个时间范围，返回这段时间内新增的安装量，注册量，以及这些新增安装中在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}
    ]
}

14.存量设备数据

接口介绍

接口描述：通过指定一个时间范围，返回这段时间内现有的存活设备数
接口地址：https://data.openinstall.io/data/event/live
请求方式： GET

请求参数

参数名说明
apiKey平台自动为每个应用单独分配的唯一标识符，可在接口配置中查看
channelCode渠道编号，可选；当指定渠道编号时，返回这个渠道的数据，否则返回整个应用的数据
platform平台过滤，可选值：android/ios，默认为android
beginDate查询的开始日期，包含当天，默认为应用创建日期，查询的时间跨度不能超过30天；格式为yyyy-MM-dd，如：2020-01-01
endDate查询的截止日期，不包含当天，默认为下一个自然日，查询的时间跨度不能超过30天；格式为yyyy-MM-dd，如：2020-01-01

结果行参数

参数名说明
date字符串；日期，返回ISO标准时间格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ；
live_d1整形数字；单日内存在活跃记录的设备数
live_d7整形数字；过去7日内存在活跃记录的设备数
live_d30整形数字；过去30日内存在活跃记录的设备数

JSON返回示例

{
    "code": 0,
    "error": null,
    "body": [
        {"date":"2019-08-20T00:00:00.000+0800","live_d1":1,"live_d7":7,"live_d30":30}
    ]
}

15.活跃数据

接口介绍

接口描述：通过指定一个时间范围，返回这段时间内的活跃设备数，活跃用户数，打开次数，在线时长；统计口径包含：按天统计/按小时统计/合计
接口地址：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},
    ]
}

16.效果点数据

接口介绍

接口描述：通过指定一个时间范围以及自定义的效果点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}
    ]
}

17.存量设备分布

接口介绍

接口描述：指定过去某个时间点，返回这个时间点在(当天/过去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}
    ]
}

18.新增设备分布

接口介绍

接口描述：通过指定一个时间范围，返回这段时间内新增的设备分组统计数据；分组方式包括：系统版本/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}
    ]
}