Get app acquisition funnel data

  • Article

Use this method in the Microsoft Store analytics API to get acquisition funnel data 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/funnel

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 acquisition funnel data. An example Store ID is 9WZDNCRFJ3Q8. Yes
startDate date The start date in the date range of acquisition funnel data to retrieve. The default is the current date. No
endDate date The end date in the date range of acquisition funnel data to retrieve. The default is the current date. No
filter string One or more statements that filter the rows in the response. For more information, see the filter fields section below. No

 

Filter fields

The filter parameter of the request contains one or more statements that filter the rows in the response. Each statement contains a field and value that are associated with the eq or ne operators, and statements can be combined using and or or.

The following filter fields are supported. String values must be surrounded by single quotes in the filter parameter.

Fields Description
campaignId The ID string for a custom app promotion campaign that is associated with the acquisition.
market A string that contains the ISO 3166 country code of the market where the acquisition occurred.
deviceType One of the following strings that specifies the device type on which the acquisition occurred:
  • PC
  • Phone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Unknown
ageGroup One of the following strings that specifies the age group of the user who completed the acquisition:
  • 0 – 17
  • 18 – 24
  • 25 – 34
  • 35 – 49
  • 50 or over
  • Unknown
gender One of the following strings that specifies the gender of the user who completed the acquisition:
  • M
  • F
  • Unknown

Request example

The following example demonstrates several requests for getting acquisition funnel data for an app. Replace the applicationId value with the Store ID for your app.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Response

Response body

Value Type Description
Value array An array of objects that contain acquisition funnel data for the app. For more information about the data in each object, see the funnel values section below.
TotalCount int The total number of objects in the Value array.

Funnel values

Objects in the Value array contain the following values.

Value Type Description
MetricType string One of the following strings that specifies the type of funnel data that is included in this object:
  • PageView
  • Acquisition
  • Install
  • Usage
UserCount string The number of users who performed the funnel step specified by the MetricType value.

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/funnel?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Sample Response

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acquisition",
            "UserCount": 1502
        },
        {
            "MetricType": "Usage",
            "UserCount": 606
        },
        {
            "MetricType": "Install",
            "UserCount": 977
        }
    ],
    "TotalCount": 4
}

Sample Request

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/21/2021&filter=market eq 'US' and gender eq 'm'
HTTP/1.1
Authorization: Bearer <your access token>

Sample Response

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 10
        },
        {
            "MetricType": "Acquisition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}