Get app installs
Use this method in the Microsoft Store analytics API to get aggregate install data in JSON format for an application during a given date range and other optional filters. This information is also available in the Acquisitions report in Partner Center.
Prerequisites
To use this method, you need to first do the following:
- If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
- Obtain an Azure AD access token to use in the request header for this method. After you obtain an access token, you have 60 minutes to use it before it expires. After the token expires, you can obtain a new one.
Request
Request syntax
Method | Request URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs |
Request header
Header | Type | Description |
---|---|---|
Authorization | string | Required. The Azure AD access token in the form Bearer <token>. |
Request parameters
Parameter | Type | Description | Required |
---|---|---|---|
applicationId | string | The Store ID of the app for which you want to retrieve install data. | Yes |
startDate | date | The start date in the date range of install data to retrieve. The default is the current date. | No |
endDate | date | The end date in the date range of install data to retrieve. The default is the current date. | No |
top | int | The number of rows of data to return in the request. The maximum value and the default value if not specified is 10000. If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. | No |
skip | int | The number of rows to skip in the query. Use this parameter to page through large data sets. For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. | No |
filter | string | One or more statements that filter the rows in the response. Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. String values must be surrounded by single quotes in the filter parameter. You can specify the following fields from the response body:
|
No |
aggregationLevel | string | Specifies the time range for which to retrieve aggregate data. Can be one of the following strings: day, week, or month. If unspecified, the default is day. | No |
orderby | string | A statement that orders the result data values for each install. The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following fields from the response body:
The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. The default is asc. Here is an example orderby string: orderby=date,market |
No |
groupby | string | A statement that applies data aggregation only to the specified fields. You can specify the following fields from the response body:
The returned data rows will contain the fields specified in the groupby parameter as well as the following:
The groupby parameter can be used with the aggregationLevel parameter. For example: &groupby=ageGroup,market&aggregationLevel=week |
No |
Request example
The following example demonstrates several requests for getting app install data. Replace the applicationId value with the Store ID for your app.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
Response
Response body
Value | Type | Description |
---|---|---|
Value | array | An array of objects that contain aggregate install data. For more information about the data in each object, see the following table. |
@nextLink | string | If there are additional pages of data, this string contains a URI that you can use to request the next page of data. For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of install data for the query. |
TotalCount | int | The total number of rows in the data result for the query. |
Elements in the Value array contain the following values.
Value | Type | Description |
---|---|---|
date | string | The first date in the date range for the install data. If the request specified a single day, this value is that date. If the request specified a week, month, or other date range, this value is the first date in that date range. |
applicationId | string | The Store ID of the app for which you are retrieving install data. |
applicationName | string | The display name of the app. |
deviceType | string | One of the following strings that specifies the type of device that completed the install:
|
packageVersion | string | The version of the package that was installed. |
osVersion | string | One of the following strings that specifies the OS version on which the install occurred:
|
market | string | The ISO 3166 country code of the market where the install occurred. |
successfulInstallCount | number | The number of successful installs that occurred during the specified aggregation level. |
Request and Response example
The following code snippets demonstrates some example request and JSON response body for those request.
Sample Request
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9WZDNCRFJB4P
HTTP/1.1
Authorization: Bearer <your access token>
Sample Response
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"successfulInstallCount": 100053
}
],
"TotalCount": 1
}
Sample Request
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=06/19/2022&endDate=07/21/2022&top=10&skip=0&groupby=applicationName,date,deviceType,market,osVersion,packageVersion&orderby=date desc
HTTP/1.1
Authorization: Bearer <your access token>
Sample Response
{
"Value": [
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "AR",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "AU",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BD",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BG",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BO",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BR",
"osVersion": "Windows 10",
"successfulInstallCount": 6
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BR",
"osVersion": "Windows 11",
"successfulInstallCount": 3
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "CA",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "CN",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "MX",
"osVersion": "Windows 10",
"successfulInstallCount": 1
}
],
"TotalCount": 10
}