| ms.assetid | description | title | ms.date | ms.topic | keywords | ms.localizationpriority |
|---|---|---|---|---|---|---|
C1E42E8B-B97D-4B09-9326-25E968680A0F | Use this method in the Microsoft Store analytics API to get aggregate acquisition data for an application during a given date range and other optional filters. | Get app acquisitions | 03/23/2018 | article | windows 10, uwp, Store services, Microsoft Store analytics API, app acquisitions | medium |
Use this method in the Microsoft Store analytics API to get aggregate acquisition 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.
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.
| Method | Request URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions |
| Header | Type | Description |
|---|---|---|
| Authorization | string | Required. The Azure AD access token in the form Bearer <token>. |
| Parameter | Type | Description | Required |
|---|---|---|---|
| applicationId | string | The Store ID of the app for which you want to retrieve acquisition data. | Yes |
| startDate | date | The start date in the date range of acquisition data to retrieve. The default is the current date. | No |
| endDate | date | The end date in the date range of acquisition 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. For example, filter=market eq 'US' and gender eq 'm'. 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 acquisition. The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
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:
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 |
The following example demonstrates several requests for getting app acquisition data. Replace the applicationId value with the Store ID for your app.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1Authorization: Bearer <your access token>GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm' HTTP/1.1Authorization: Bearer <your access token>| Value | Type | Description |
|---|---|---|
| Value | array | An array of objects that contain aggregate acquisition data for the app. For more information about the data in each object, see the acquisition values section below. |
| @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 acquisition 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 acquisition 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 acquisition data. |
| applicationName | string | The display name of the app. |
| deviceType | string | One of the following strings that specifies the type of device on which the acquisition occurred:
|
| orderName | string | The name of the order. |
| storeClient | string | One of the following strings that indicates the version of the Store where the acquisition occurred:
|
| osVersion | string | One of the following strings that specifies the OS version on which the acquisition occurred:
|
| market | string | The ISO 3166 country code of the market where the acquisition occurred. |
| gender | string | One of the following strings that specifies the gender of the user who made the acquisition:
|
| ageGroup | string | One of the following strings that specifies the age group of the user who made the acquisition:
|
| acquisitionType | string | One of the following strings that indicates the type of acquisition:
|
| acquisitionQuantity | number | The number of acquisitions that occurred during the specified aggregation level. |
The following code snippets demonstrates some example request and JSON response body for those request.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR HTTP/1.1Authorization: Bearer <your access token>{ "Value": [ { "applicationId": "9NBLGGGZ5QDR", "date": "2022-07-29", "acquisitionQuantity": 7, "purchasePriceUSDAmount": 0.0, "purchasePriceLocalAmount": 0.0, "purchaseTaxUSDAmount": 0.0, "purchaseTaxLocalAmount": 0.0 }, ], "TotalCount": 1, "DataFreshnessTimestamp": "2022-07-29T08:42:00" }GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType HTTP/1.1Authorization: Bearer <your access token> { "Value": [ { "applicationId": "9NBLGGGZ5QDR", "applicationName": "Contoso Demo", "acquisitionType": "Free", "storeClient": "Microsoft Store (client)", "gender": "f", "market": "TW", "osVersion": "Windows 10", "deviceType": "PC", "date": "2021-08-01", "acquisitionQuantity": 1, "purchasePriceUSDAmount": 0.0, "purchasePriceLocalAmount": 0.0, "purchaseTaxUSDAmount": 0.0, "purchaseTaxLocalAmount": 0.0 }, { "applicationId": "9NBLGGGZ5QDR", "applicationName": "Contoso Demo", "acquisitionType": "Free", "storeClient": "Microsoft Store (client)", "gender": "Unknown", "market": "BR", "osVersion": "Windows 10", "deviceType": "PC", "date": "2021-08-01", "acquisitionQuantity": 1, "purchasePriceUSDAmount": 0.0, "purchasePriceLocalAmount": 0.0, "purchaseTaxUSDAmount": 0.0, "purchaseTaxLocalAmount": 0.0 }, ], "TotalCount": 2, "DataFreshnessTimestamp": "2022-07-29T08:42:00" }