Skip to content

Latest commit

 

History

History
152 lines (106 loc) · 12.6 KB

access-analytics-data-using-windows-store-services.md

File metadata and controls

152 lines (106 loc) · 12.6 KB
author ms.assetid description title ms.author ms.date ms.topic ms.prod ms.technology keywords ms.localizationpriority
mcleanbyron
4BF9EF21-E9F0-49DB-81E4-062D6E68C8B1
Use the Microsoft Store analytics API to programmatically retrieve analytics data for apps that are registered to your or your organization''s Windows Dev Center account.
Access analytics data using Store services
mcleans
03/23/2018
article
windows
uwp
windows 10, uwp, Store services, Microsoft Store analytics API
medium

Access analytics data using Store services

Use the Microsoft Store analytics API to programmatically retrieve analytics data for apps that are registered to your or your organization's Windows Dev Center account. This API enables you to retrieve data for app and add-on (also known as in-app product or IAP) acquisitions, errors, app ratings and reviews. This API uses Azure Active Directory (Azure AD) to authenticate the calls from your app or service.

The following steps describe the end-to-end process:

  1. Make sure that you have completed all the prerequisites.
  2. Before you call a method in the Microsoft Store analytics API, obtain an Azure AD access token. After you obtain a token, you have 60 minutes to use this token in calls to the Microsoft Store analytics API before the token expires. After the token expires, you can generate a new token.
  3. Call the Microsoft Store analytics API.

Step 1: Complete prerequisites for using the Microsoft Store analytics API

Before you start writing code to call the Microsoft Store analytics API, make sure that you have completed the following prerequisites.

  • You (or your organization) must have an Azure AD directory and you must have Global administrator permission for the directory. If you already use Office 365 or other business services from Microsoft, you already have Azure AD directory. Otherwise, you can create a new Azure AD in Dev Center for no additional charge.

  • You must associate an Azure AD application with your Dev Center account, retrieve the tenant ID and client ID for the application and generate a key. The Azure AD application represents the app or service from which you want to call the Microsoft Store analytics API. You need the tenant ID, client ID and key to obtain an Azure AD access token that you pass to the API.

    [!NOTE] You only need to perform this task one time. After you have the tenant ID, client ID and key, you can reuse them any time you need to create a new Azure AD access token.

To associate an Azure AD application with your Dev Center account and retrieve the required values:

  1. In Dev Center, go to your Account settings, click Manage users, and associate your organization's Dev Center account with your organization's Azure AD directory.

  2. In the Manage users page, click Add Azure AD applications, add the Azure AD application that represents the app or service that you will use to access analytics data for your Dev Center account, and assign it the Manager role. If this application already exists in your Azure AD directory, you can select it on the Add Azure AD applications page to add it to your Dev Center account. Otherwise, you can create a new Azure AD application on the Add Azure AD applications page. For more information, see Add Azure AD applications to your Dev Center account.

  3. Return to the Manage users page, click the name of your Azure AD application to go to the application settings, and copy down the Tenant ID and Client ID values.

  4. Click Add new key. On the following screen, copy down the Key value. You won't be able to access this info again after you leave this page. For more information, see Manage keys for an Azure AD application.

Step 2: Obtain an Azure AD access token

Before you call any of the methods in the Microsoft Store analytics API, you must first obtain an Azure AD access token that you pass to the Authorization header of each method in the API. After you obtain an access token, you have 60 minutes to use it before it expires. After the token expires, you can refresh the token so you can continue to use it in further calls to the API.

To obtain the access token, follow the instructions in Service to Service Calls Using Client Credentials to send an HTTP POST to the https://login.microsoftonline.com/<tenant_id>/oauth2/token endpoint. Here is a sample request.

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

For the tenant_id value in the POST URI and the client_id and client_secret parameters, specify the tenant ID, client ID and the key for your application that you retrieved from Dev Center in the previous section. For the resource parameter, you must specify https://manage.devcenter.microsoft.com.

After your access token expires, you can refresh it by following the instructions here.

Step 3: Call the Microsoft Store analytics API

After you have an Azure AD access token, you are ready to call the Microsoft Store analytics API. You must pass the access token to the Authorization header of each method.

Methods for UWP apps

The following analytics methods are available for UWP apps in Dev Center.

Scenario Methods
Acquisitions, conversions, and installs
App errors
Ratings and reviews
In-app ads and ad campaigns

Methods for desktop applications

The following analytics methods are available for use by developer accounts that belong to the Windows Desktop Application program.

Scenario Methods
Installs
Application errors

Methods for hardware and drivers

The following analytics methods are available for use by developer accounts that belong to the Windows Hardware Dev Center program.

Scenario Methods
Errors in Windows 10 drivers (for IHVs)
Errors in Windows 7/Windows 8.x drivers (for IHVs)
Hardware errors (for OEMs)

Methods for Xbox Live services

The following additional methods are available for use by developer accounts with games that use Xbox Live services.

Scenario Methods
General analytics
Health analytics
Community analytics

Methods for Xbox One games

The following additional methods are available for use by developer accounts with Xbox One games that were ingested through the Xbox Developer Portal (XDP) and available in the XDP Analytics Dev Center dashboard.

Scenario Methods
Acquisitions

Code example

The following code example demonstrates how to obtain an Azure AD access token and call the Microsoft Store analytics API from a C# console app. To use this code example, assign the tenantId, clientId, clientSecret, and appID variables to the appropriate values for your scenario. This example requires the Json.NET package from Newtonsoft to deserialize the JSON data returned by the Microsoft Store analytics API.

[!div class="tabbedCodeSnippets"] [!code-csAnalyticsApi]

Error responses

The Microsoft Store analytics API returns error responses in a JSON object that contains error codes and messages. The following example demonstrates an error response caused by an invalid parameter.

{
    "code":"BadRequest",
    "data":[],
    "details":[],
    "innererror":{
        "code":"InvalidQueryParameters",
        "data":[
            "top parameter cannot be more than 10000"
        ],
        "details":[],
        "message":"One or More Query Parameters has invalid values.",
        "source":"AnalyticsAPI"
    },
    "message":"The calling client sent a bad request to the service.",
    "source":"AnalyticsAPI"
}