forked from MicrosoftDocs/windows-dev-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merged PR 10236: Documented several new Store REST APIs for insights …
…data
- Loading branch information
1 parent
b3d0fa0
commit edc2fec
Showing
4 changed files
with
312 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
windows-apps-src/monetize/get-insights-data-for-your-app.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| --- | ||
| author: mcleanbyron | ||
| description: Use this method in the Microsoft Store analytics API to get insights data for your app. | ||
| title: Get insights data | ||
| ms.author: mcleans | ||
| ms.date: 07/31/2018 | ||
| ms.topic: article | ||
| ms.prod: windows | ||
| ms.technology: uwp | ||
| keywords: windows 10, uwp, Store services, Microsoft Store analytics API, insights | ||
| ms.localizationpriority: medium | ||
| --- | ||
|
|
||
| # Get insights data | ||
|
|
||
| Use this method in the Microsoft Store analytics API to get insights data related to acquisitions, health, and usage metrics for an app during a given date range and other optional filters. This information is also available in the [Insights report](../publish/insights-report.md) in the Windows Dev Center dashboard. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
|
|
||
| To use this method, you need to first do the following: | ||
|
|
||
| * If you have not done so already, complete all the [prerequisites](access-analytics-data-using-windows-store-services.md#prerequisites) for the Microsoft Store analytics API. | ||
| * [Obtain an Azure AD access token](access-analytics-data-using-windows-store-services.md#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/insights``` | | ||
|
|
||
|
|
||
| ### 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](in-app-purchases-and-trials.md#store-ids) of the app for which you want to retrieve insights data. If you do not specify this parameter, the response body will contain insights data for all apps registered to your account. | No | | ||
| | startDate | date | The start date in the date range of insights data to retrieve. The default is 30 days before the current date. | No | | ||
| | endDate | date | The end date in the date range of insights data to retrieve. The default is the current date. | 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=dataType eq 'acquisition'*. <p/><p/>You can specify the following filter fields:<p/><ul><li><strong>acquisition</strong></li><li><strong>health</strong></li><li><strong>usage</strong></li></ul> | No | | ||
|
|
||
| ### Request example | ||
|
|
||
| The following example demonstrates a request for getting insights data. Replace the *applicationId* value with the Store ID for your app. | ||
|
|
||
| ```syntax | ||
| GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'acquisition' or dataType eq 'health' HTTP/1.1 | ||
| Authorization: Bearer <your access token> | ||
| ``` | ||
| ## Response | ||
| ### Response body | ||
| | Value | Type | Description | | ||
| |------------|--------|-------------------------------------------------------| | ||
| | Value | array | An array of objects that contain insights data for the app. For more information about the data in each object, see the [Insight values](#insight-values) section below. | | ||
| | TotalCount | int | The total number of rows in the data result for the query. | | ||
| ### Insight values | ||
| Elements in the *Value* array contain the following values. | ||
| | Value | Type | Description | | ||
| |---------------------|--------|-------------------------------------------| | ||
| | applicationId | string | The Store ID of the app for which you are retrieving insights data. | | ||
| | insightDate | string | The date on which we identified the change in a specific metric. This date represents the end of the week in which we detected a significant increase or decrease in a metric compared to the week before that. | | ||
| | dataType | string | One of the following strings that specifies the general analytics area that this insight describes:<p/><ul><li><strong>acquisition</strong></li><li><strong>health</strong></li><li><strong>usage</strong></li></ul> | | ||
| | insightDetail | array | One or more [InsightDetail values](#insightdetail-values) that represent the details for current insight. | | ||
| ### InsightDetail values | ||
| | Value | Type | Description | | ||
| |---------------------|--------|-------------------------------------------| | ||
| | FactName | string | One of the following values that indicates the metric that the current insight or current dimension describes, based on the **dataType** value.<ul><li>For **health**, this value is always **HitCount**.</li><li>For **acquisition**, this value is always **AcquisitionQuantity**.</li><li>For **usage**, this value can be one of the following strings:<ul><li><strong>DailyActiveUsers</strong></li><li><strong>EngagementDurationMinutes</strong></li><li><strong>DailyActiveDevices</strong></li><li><strong>DailyNewUsers</strong></li><li><strong>DailySessionCount</strong></li></ul></ul> | | ||
| | SubDimensions | array | One or more objects that describe a single metric for the insight. | | ||
| | PercentChange | string | The percentage that the metric changed across your entire customer base. | | ||
| | DimensionName | string | The name of the metric described in the current dimension. Examples include **EventType**, **Market**, **DeviceType**, **PackageVersion**, **AcquisitionType**, **AgeGroup** and **Gender**. | | ||
| | DimensionValue | string | The value of the metric that is described in the current dimension. For example, if **DimensionName** is **EventType**, **DimensionValue** might be **crash** or **hang**. | | ||
| | FactValue | string | The absolute value of the metric on the date the insight was detected. | | ||
| | Direction | string | The direction of the change (**Positive** or **Negative**). | | ||
| | Date | string | The date on which we identified the change related to the current insight or the current dimension. | | ||
| ### Response example | ||
| The following example demonstrates an example JSON response body for this request. | ||
| ```json | ||
| { | ||
| "Value": [ | ||
| { | ||
| "applicationId": "9NBLGGGZ5QDR", | ||
| "insightDate": "2018-06-03T00:00:00", | ||
| "dataType": "health", | ||
| "insightDetail": [ | ||
| { | ||
| "FactName": "HitCount", | ||
| "SubDimensions": [ | ||
| { | ||
| "FactName:": "HitCount", | ||
| "PercentChange": "21", | ||
| "DimensionValue:": "DE", | ||
| "FactValue": "109", | ||
| "Direction": "Positive", | ||
| "Date": "6/3/2018 12:00:00 AM", | ||
| "DimensionName": "Market" | ||
| } | ||
| ], | ||
| "DimensionValue": "crash", | ||
| "Date": "6/3/2018 12:00:00 AM", | ||
| "DimensionName": "EventType" | ||
| }, | ||
| { | ||
| "FactName": "HitCount", | ||
| "SubDimensions": [ | ||
| { | ||
| "FactName:": "HitCount", | ||
| "PercentChange": "71", | ||
| "DimensionValue:": "JP", | ||
| "FactValue": "112", | ||
| "Direction": "Positive", | ||
| "Date": "6/3/2018 12:00:00 AM", | ||
| "DimensionName": "Market" | ||
| } | ||
| ], | ||
| "DimensionValue": "hang", | ||
| "Date": "6/3/2018 12:00:00 AM", | ||
| "DimensionName": "EventType" | ||
| }, | ||
| ], | ||
| "insightId": "9CY0F3VBT1AS942AFQaeyO0k2zUKfyOhrOHc0036Iwc=" | ||
| } | ||
| ], | ||
| "@nextLink": null, | ||
| "TotalCount": 2 | ||
| } | ||
| ``` | ||
|
|
||
| ## Related topics | ||
|
|
||
| * [Insights report](../publish/insights-report.md) | ||
| * [Access analytics data using Microsoft Store services](access-analytics-data-using-windows-store-services.md) |
Oops, something went wrong.