Openinstall Data Interface #
All statistical data for applications and channels are provided to developers in the form of HTTP interfaces. Developers can use these data interfaces to fetch data for their own storage or for secondary development of reports.
Interface Configuration #
Please register and log in to the OpenInstall console as a developer, navigate to "Data Interface" -> "Interface Configuration," and enable the data interface switch and other configurations.
Interface Specifications #
1.Channel Group List
2.Channel Group Creation
3.Channel Group Modification
4.Channel Group Deletion
5.Channel Creation/Modification
6.Channel Details
7.Channel List
8.Channel Deletion
9.Sub-channel List
10.Sub-channel Addition
11.Sub-channel Modification
12.Sub-channel Deletion
13.New Installation Data
14.Inventory Device Data
15.Active Data
16.Effect Point Data
17.Stock Device Distribution
18.New Device Distribution
1.Channel Group List #
Interface Description
Interface Description: Returns all channel groups under the current application. Each application has a default group (default), and all channels not specified in a group belong to the default group. The default group cannot be modified or deleted.
Interface URL: https://data.openinstallglobal.com/data/group/list
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
Result parameters
Parameter Name | Explanation |
---|---|
groupName | String; Name of the channel group JSON Response Example |
JSON Response Example
{
"code": 0,
"error": null,
"body": [
{"groupName":"default"},
{"groupName":"Google"},
{"groupName":"Facebook"},
{"groupName":"Share"}
]
}
2.Channel Group Creation #
Interface Introduction
Interface Description: Create a new channel group. If the group name conflicts, an error will be returned. Up to 30 groups can be created.
Interface URL: https://data.openinstallglobal.com/data/group/add
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
groupName | String; channel group name |
Result Parameters
Parameter Name | Explanation |
---|---|
groupName | String; Name of the channel group |
JSON Response Example
{
"code": 0,
"error": null,
"body": {
"groupName": "Ad Group B"
}
}
3.Channel Group Modification #
Interface Introduction
Interface Description: Modify the channel group
Interface URL: https://data.openinstallglobal.com/data/group/update
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
groupName | String; channel group name |
newGroupName | String;Modified channel group name |
Result Parameters
Parameter Name | Explanation |
---|---|
groupName | String; Name of the channel group |
JSON Response Example
{
"code": 0,
"error": null,
"body": {
"groupName": "Ad Groub C"
}
}
4.Channel group deletion #
Interface Description
Interface Description: Delete channel group, and all subordinate channels enter the default group.
Interface Address: https://data.openinstallglobal.com/data/group/delete
Request Method: GET
Request Parameters
Request Parameters | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
groupName | String; Name of the channel group |
JSON Response Example
{
"code": 0,
"error": null,
"body": null
}
5.Channel creation/modification #
Interface Description
Description: Create a new H5 channel by specifying the channel ID, name, etc. If the channel ID already exists, modify the existing channel information.
Interface URL: https://data.openinstallglobal.com/data/channel/add
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
channelCode | String, required; When channelCode already exists, it indicates channel modification; otherwise, it indicates creating a new channel |
channelName | String, required; Channel Name |
customURL | String, optional; Custom landing page URL, empty indicates using the default landing page |
groupName | String, optional; channel group name |
allowChild | Whether sub-channels can be created, only available when creating a new channel, optional values: 0/1; default is 0 |
sharePrivate | Whether the report sharing page requires password protection, optional values: 0/1; default is 1 |
sharePassword | String, password for the report sharing page; a randomly generated password is used by default |
Result Parameters
Parameter Name | Explanation |
---|---|
channelCode | String; channel ID |
channelName | String; Channel Name |
customURL | String; Custom landing page URL, empty indicates using the default landing page |
linkUrl | String; Channel publishing address, i.e., adding the channelCode parameter to the landing page URL |
createTime | String; Creation date, returned in ISO standard time format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
allowChild | Boolean; Whether sub-channels can be created |
shareUrl | String; Report sharing page address |
sharePrivate | Boolean; Whether the report sharing page requires password protection |
sharePassword | String; Password for the report sharing page |
groupName | String; Group name |
JSON Response Example
{
"code": 0,
"error": null,
"body": {
"channelCode": "001",
"channelName": "Ad 001",
"customUrl": null,
"linkUrl": "https://app-i469do.openinstallpage.com/page/i469do/channel-landing?channelCode=001",
"createTime": "2022-04-18T16:07:35.102+0800",
"allowChild": false,
"shareUrl": "https://report.openinstallglobal.com/channel/1095401724/625d1c47a41fc481e33ceb9d",
"sharePrivate": true,
"sharePassword": "mKfFOb",
"groupName": "Ad Group C"
}
}
6. Channel Details #
Interface Introduction
Interface Description: Retrieve detailed information of a single H5 channel by specifying the channel ID.
Interface URL: https://data.openinstallglobal.com/data/channel/get
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration |
channelCode | string, required; channel ID |
Result Parameters
Parameter Name | Explanation |
---|---|
channelCode | String; channel ID |
channelName | String; Channel Name |
customURL | String; Custom landing page URL, empty indicates using the default landing page |
linkUrl | String; Channel publishing address, i.e., adding the channelCode parameter to the landing page URL |
createTime | String; Creation date, returned in ISO standard time format:yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
allowChild | Boolean; Whether sub-channels can be created |
shareUrl | String; Report sharing page address |
sharePrivate | Boolean; Whether the report sharing page requires password protection |
sharePassword | String; Password for the report sharing page |
groupName | String; Group name |
JSON Response Example
{
"code": 0,
"error": null,
"body": {
"channelCode": "001",
"channelName": "ad 001",
"customUrl": null,
"linkUrl": "https://app-i469do.openinstallpage.com/page/i469do/channel-landing?channelCode=001",
"createTime": "2022-04-18T16:07:35.102+0800",
"allowChild": false,
"shareUrl": "https://report.openinstallglobal.com/channel/1095401724/625d1c47a41fc481e33ceb9d",
"sharePrivate": true,
"sharePassword": "mKfFOb",
"groupName": "ad C"
}
}
7.Channel List #
Interface Introduction
Interface Description: Retrieve H5 channel list information data by executing query conditions, supporting pagination
Interface URL: https://data.openinstallglobal.com/data/channel/list
Request Parameters: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
pageNum | Integer number, page number starting from 0; current page number |
pageSize | Integer number, up to 100, default is 10; total number of items per page |
sortField | String, optional values are createTime/channelCode/channelName, default is createTime; field for sorting |
asc | Whether to sort in ascending order, optional values: 0/1; default is 0; descending/ascending |
search | String, optional channel ID or channel name |
groupName | String, optional; channel group name |
Result Parameters
Parameter Name | Explanation |
---|---|
channelCode | String; channel ID |
channelName | String; Channel Name |
customURL | String; Custom landing page URL, empty indicates using the default landing page |
linkUrl | String; Channel publishing address, i.e., adding the channelCode parameter to the landing page URL |
createTime | String; Creation date, returned in ISO standard time format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
allowChild | Boolean; Whether sub-channels can be created |
shareUrl | String; Report sharing page address |
sharePrivate | Boolean; Whether the report sharing page requires password protection |
sharePassword | String; Password for the report sharing page |
groupName | String; Group name |
JSON Response Example
{
"code": 0,
"error": null,
"body": [
{"channelCode":"001","channelName":"ad 001","customUrl":null,"linkUrl":"https://app-i469do.openinstallpage.com/page/i469do/channel-landing?channelCode=001","createTime":"2022-04-18T16:07:35.102+0800","allowChild":false,"shareUrl":"https://report.openinstallglobal.com/channel/1095401724/625d1c47a41fc481e33ceb9d","sharePrivate":true,"sharePassword":"mKOfFb","groupName":"ad group C"}
],
"pageInfo": {
"total": 1,
"hasNext": false,
"hasPrev": false,
"pages": 1,
"pageNum": 0
}
}
8.Channel Deletion #
API Introduction
Interface Description: Delete H5 channels by specifying the channel ID.
Interface URL: https://data.openinstallglobal.com/data/channel/delete
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
channelCode | String array; channel ID, supports deleting multiple channels simultaneously |
JSON Response Example
{
"code": 0,
"error": null,
"body": null
}
9.Sub-channel List #
Interface Introduction
Interface description: Retrieves the list of sub-channels under a specified parent channel, with support for pagination
Interface URL: https://data.openinstallglobal.com/data/channel/child/list
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
pageNum | Integer number, page number starting from 0; current page number |
pageSize | Integer number, up to 100, default is 10; total number of items per page |
sortField | String, optional values are createTime/channelCode/channelName, default is createTime; field for sorting |
asc | Whether to sort in ascending order, optional values: 0/1; default is 0; descending/ascending |
parentChannelCode | String, required; parentChannelCode |
Result Parameters
Parameter Name | Explanation |
---|---|
channelCode | String; channel ID |
channelName | String; Channel Name |
customURL | String; Custom landing page URL, empty indicates using the default landing page |
linkUrl | String; Channel publishing address, i.e., adding the channelCode parameter to the landing page URL |
createTime | String; Creation date, returned in ISO standard time format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
allowChild | Boolean; Whether sub-channels can be created |
shareUrl | String; Report sharing page address |
sharePrivate | Boolean; Whether the report sharing page requires password protection |
sharePassword | String; Password for the report sharing page |
parentChannelCode | String; parentChannelCode |
JSON Response Example
{
"code": 0,
"error": null,
"body": [
{"channelCode":"001*1","channelName":"child001","customUrl":null,"linkUrl":"https://app-i469do.openinstallpage.com/page/i469do/channel-landing?channelCode=001*1","createTime":"2022-04-18T16:37:25.482+0800","allowChild":false,"shareUrl":"https://report.openinstallglobal.com/channel/1095401724/625d2345a41fc481e354d821","sharePrivate":true,"sharePassword":"654321","parentChannelCode":"001"}
],
"pageInfo": {
"total": 1,
"hasNext": false,
"hasPrev": false,
"pages": 1,
"pageNum": 0
}
}
10.Sub-channel Addition #
Interface Description
Interface Description: Add a subordinate sub-channel by specifying the parent channel ID.
Interface Address: https://data.openinstallglobal.com/data/channel/child/add
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
parentChannelCode | String, required; parentChannelCode |
channelName | String, required; Name of the sub-channel |
sharePrivate | whether the report sharing page requires password protection. Possible values: 0/1; default is 1 |
sharePassword | String; Password for the report sharing page. When this field is not present, the default random password is used. Providing an empty string cancels password access restrictions. |
Result Parameters
Parameter Name | Explanation |
---|---|
channelCode | String; Channel ID |
channelName | String; Channel Name |
customURL | String; Custom landing page URL. Empty when using the default landing page. |
linkUrl | String; Channel release address, i.e., adding the channelCode parameter after the landing page URL |
createTime | String; Creation date, returned in ISO standard time format:yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
allowChild | Boolean; Whether sub-channels can be created |
shareUrl | String; Report sharing page address |
sharePrivate | Boolean; Whether the report sharing page requires password protection. Possible values: 0/1; |
sharePassword | String; Password for the report sharing page |
parentChannelCode | String; parentChannelCode |
JSON Response Example
{
"code": 0,
"error": null,
"body": {
"channelCode": "001*1",
"channelName": "child001",
"customUrl": null,
"linkUrl": "https://app-i469do.openinstallpage.com/page/i469do/channel-landing?channelCode=001*1",
"createTime": "2022-04-18T16:37:25.482+0800",
"allowChild": false,
"shareUrl": "https://report.openinstallglobal.com/channel/1095401724/625d2345a41fc481e354d821",
"sharePrivate": true,
"sharePassword": "654321",
"parentChannelCode": "001"
}
}
11.Sub-channel Update #
Interface Introduction
Interface Description: Modify a sub-channel by specifying the parent channel ID.
Interface Address: https://data.openinstallglobal.com/data/channel/child/update
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
parentChannelCode | String, required; parentChannelCode |
channelCode | String, required; sub-channel ID |
channelName | String, required; Name of the sub-channel |
sharePrivate | whether the report sharing page requires password protection. Possible values: 0/1; default is 1 |
sharePassword | String; Password for the report sharing page. When this field is not present, the default random password is used. Providing an empty string cancels password access restrictions. |
Result Parameters
Parameter Name | Explanation |
---|---|
channelCode | String; Channel ID |
channelName | String; Channel Name |
customURL | String; Custom landing page URL. Empty when using the default landing page. |
linkUrl | String; Channel release address, i.e., adding the channelCode parameter after the landing page URL |
createTime | String; Creation date, returned in ISO standard time format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
allowChild | Boolean; Whether sub-channels can be created |
shareUrl | String; Report sharing page address |
sharePrivate | Boolean; Whether the report sharing page requires password protection |
sharePassword | String; Password for the report sharing page |
parentChannelCode | String; parentChannelCode |
JSON Response Example
{
"code": 0,
"error": null,
"body": {
"channelCode": "001*1",
"channelName": "child001",
"customUrl": null,
"linkUrl": "https://app-i469do.openinstallpage.com/page/i469do/channel-landing?channelCode=001*1",
"createTime": "2022-04-18T16:37:25.482+0800",
"allowChild": false,
"shareUrl": "https://report.openinstallglobal.com/channel/1095401724/625d2345a41fc481e354d821",
"sharePrivate": true,
"sharePassword": "654321",
"parentChannelCode": "001"
}
}
12.Sub-channel deletion #
Interface Introduction
Interface Description: Modify a sub-channel by specifying the parent channel ID.
Interface URL: https://data.openinstallglobal.com/data/channel/child/delete
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
parentChannelCode | String, required; parentChannelCode |
channelCode | string, required; sub-channel ID |
JSON Response Example
{
"code": 0,
"error": null,
"body": null
}
13. New Installation Data #
Interface Introduction
Interface Description: By specifying a time range, return the number of new installations, registrations, and retention numbers after 1/7/30 days within that time period; statistical paths include: daily statistics / hourly statistics / total.
Interface URL: https://data.openinstallglobal.com/data/event/growth
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
channelCode | channelCode: Optional; When specifying the channel ID, returns the data for that channel; otherwise, returns the data for the entire application |
platform | Platform filter; optional values: android/ios, default is android |
beginDate | The start date of the query, including the current day, default is the application creation date; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
endDate | The end date of the query, excluding the current day, default is the next natural day; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
groupBy | Optional values: day/hour/sum, default is day; indicating daily statistics/hourly statistics/total |
excludeDuplication | Whether to exclude duplicated installation data; optional values: 0/1, default is 0; representing: do not exclude/exclude. |
Result Parameters
Parameter Name | Explanation |
---|---|
date | String; date, in ISO standard format: yyyy-MM-dd’T’HH:mm:ss.SSSZ;returns empty when groupBy=sum |
visit | Integer; number of visits to the landing page |
click | Integer; number of clicks on the landing page |
install | Integer; installations |
register | Integer; registrations |
survive_d1 | Integer; retention number after 1 day |
survive_d7 | Integer; retention number after 7 days |
survive_d30 | Integer; Retention number after 30 days |
JSON Response Example
{
"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.Inventory Device Data #
Interface Introduction
Interface Description: By specifying a time range, this interface returns the count of active devices within that period.
Interface URL: https://data.openinstallglobal.com/data/event/live
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
channelCode | channelCode: Optional; When specifying the channel ID, returns the data for that channel; otherwise, returns the data for the entire application |
platform | Platform filter, optional values: android/ios, default is android |
beginDate | The start date of the query, including the current day, default is the application creation date; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
endDate | The end date of the query, excluding the current day, default is the next natural day; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
Result Parameters
Parameter Name | Explanation |
---|---|
date | String; date, in ISO standard format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; |
live_d1 | Integer; Number of devices with active records within a single day |
live_d7 | Integer; Number of devices with active records within the past 7 days |
live_d30 | Integer; Number of devices with active records within the past 30 days |
JSON Response Example
{
"code": 0,
"error": null,
"body": [
{"date":"2019-08-20T00:00:00.000+0800","live_d1":1,"live_d7":7,"live_d30":30}
]
}
15.Active Data #
Interface Introduction
Interface Description: Retrieves the count of active devices, active users, number of app launches, and online duration within a specified time range. statistical paths include: daily statistics / hourly statistics / total
Interface URL: https://data.openinstallglobal.com/data/event/active
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
channelCode | channelCode: Optional; When specifying the channel ID, returns the data for that channel; otherwise, returns the data for the entire application |
platform | Platform filter, optional values: android/ios, default is android |
beginDate | The start date of the query, including the current day, default is the application creation date; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
endDate | The end date of the query, excluding the current day, default is the next natural day; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
groupBy | Optional values: day/hour/sum, default is day; indicating daily statistics/hourly statistics/total |
Result Parameters
Parameter Name | Explanation |
---|---|
date | String; date, in ISO standard format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; returns empty when groupBy=sum |
device | Integer; Active Devices |
user | Integer; Active Users |
count | Integer; Total number of activations |
duration | Integer; Total duration of activity, in seconds JSON Response Example |
JSON Response Example
{
"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. Effect Point Data #
Interface Introduction
Interface Description: By specifying a time range and a custom effect point ID, this interface returns the cumulative value and unique device count of this effect point within the specified time period. statistical paths include: daily statistics / hourly statistics / total
Interface URL: https://data.openinstallglobal.com/data/event/custom
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration. |
channelCode | channelCode: Optional; When specifying the channel ID, returns the data for that channel; otherwise, returns the data for the entire application |
platform | Platform filter, optional values: android/ios, default is android |
beginDate | The start date of the query, including the current day, default is the application creation date; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
endDate | The end date of the query, excluding the current day, default is the next natural day; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
groupBy | Optional values: day/hour/sum, default is day; indicating daily statistics/hourly statistics/total |
eventCode | Custom effect point ID |
Result Parameters
Parameter Name | Explanation |
---|---|
date | String; date, in ISO standard format: yyyy-MM-dd’T’HH:mm:ss.SSSZ; returns empty when groupBy=sum |
eventValue | Integer; Cumulative value of the effect point |
device | Integer; Number of unique devices |
JSON Response Example
{
"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. Device Distribution #
Interface Introduction
Interface Description: Specify a specific time point in the past and return the grouped statistical data of devices that have had activity records at this time point within (today/past 7 days/past 30 days); grouping methods include: system version/app version/model/country/province/total
Interface Address: https://data.openinstallglobal.com/data/sum/live
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration |
channelCode | channelCode: Optional; When specifying the channel ID, returns the data for that channel; otherwise, returns the data for the entire application |
platform | Platform filter, optional values: android/ios, default is android |
date | Date, default is today; format is yyyy-MM-dd, for example: 2020-01-01 |
type | Criteria for determining active devices, optional values: d0/d7/d30, default is d0; indicating: active today/in the past 7 days/in the past 30 days |
sumBy | Grouping method, optional values: system_version/app_version/brand_model/country/state/total, default is total; respectively representing: system version/app version/brand model/country/state/total |
Result Parameters
Parameter Name | Explanation |
---|---|
key | String; Key for grouping statistics, corresponding to specific meanings with sumBy |
value | Integer; Total number of devices |
JSON Response Example
{
"code": 0,
"error": null,
"body": [
{"key":"1.0.3","value":31},
{"key":"1.0.4","value":11},
{"key":"1.0.1","value":1}
]
}
18.New Device Distribution #
Interface Introduction
Description: Returns statistical data of newly added devices grouped by specified criteria within a specified time range; grouping methods include: system version/app version/model/country/province/total
Interface URL: https://data.openinstallglobal.com/data/sum/growth
Request Method: GET
Request Parameters
Parameter Name | Explanation |
---|---|
apiKey | The platform automatically assigns a unique identifier to each application, which can be viewed in the interface configuration |
channelCode | channelCode: Optional; When specifying the channel ID, returns the data for that channel; otherwise, returns the data for the entire application |
platform | Platform filter, optional values: android/ios, default is android |
beginDate | The start date of the query, including the current day, default is the application creation date; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
endDate | The end date of the query, excluding the current day, default is the next natural day; the query time span cannot exceed 30 days; format is yyyy-MM-dd, for example: 2020-01-01 |
excludeDuplication | Whether to exclude duplicated installation data, optional values: 0/1, default is 0;representing: do not exclude/exclude |
sumBy | optional values: system_version/app_version/brand_model/country/state/total,default is total; respectively representing: system version/app version/brand model/country/state/total |
Result Parameters
Parameter Name | Explanation |
---|---|
key | String; Key for grouping statistics, corresponding to specific meanings with sumBy |
value | Integer; Total number of devices |
JSON Response Example
{
"code": 0,
"error": null,
"body": [
{"key":"total","value":118}
]
}