Get upgrade block details for your desktop application

Use this REST URI to get details for Windows 10 devices on which a specific executable in your desktop application is blocking a Windows 10 upgrade from running. You can use this URI only for desktop applications that you have added to the Windows Desktop Application program. This information is also available in the Application blocks report for desktop applications in Partner Center.

This URI is similar to Get upgrade blocks for your desktop application, but it returns device block info for a specific executable in your desktop application.

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/desktop/blockdetails

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 product ID of the desktop application for which you want to retrieve block data. To get the product ID of a desktop application, open any analytics report for your desktop application in Partner Center (such as the Blocks report) and retrieve the product ID from the URL. Yes
fileName string The name of the blocked executable
startDate date The start date in the date range of block data to retrieve. The default is 90 days prior to the current date. No
endDate date The end date in the date range of block 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:

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • market
  • osRelease
  • osVersion
  • productName
  • targetOs
No
orderby string A statement that orders the result data values for each block. The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following fields from the response body:

  • applicationVersion
  • architecture
  • blockType
  • date
  • deviceType
  • market
  • osRelease
  • osVersion
  • productName
  • targetOs
  • deviceCount

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:

  • applicationVersion
  • architecture
  • blockType
  • deviceType
  • market
  • osRelease
  • osVersion
  • targetOs

The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • applicationId
  • date
  • productName
  • deviceCount

No

Request example

The following example demonstrates several requests for getting desktop application block data. Replace the applicationId value with the Product ID for your desktop application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&startDate=2018-05-01&endDate=2018-06-07&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockdetails?applicationId=10238467886765136388&fileName=contoso.exe&startDate=2018-05-01&endDate=2018-06-07&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 block 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 block 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
applicationId string The product ID of the desktop application for which you retrieved block data.
date string The date associated with the block hits value.
productName string The display name of the desktop application as derived from the metadata of its associated executable(s).
fileName string The executable that was blocked.
applicationVersion string The version of the application executable that was blocked.
osVersion string One of the following strings that specifies the OS version on which the desktop application is currently running:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the desktop application is currently running.

For Windows 10:

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • Version 1709
  • Release Preview
  • Insider Fast
  • Insider Slow

For Windows Server 1709:

  • RTM

For Windows Server 2016:

  • Version 1607

For Windows 8.1:

  • Update 1

For Windows 7:

  • Service Pack 1

If the OS release or flighting ring is unknown, this field has the value Unknown.

market string The ISO 3166 country code of the market in which the desktop application is blocked.
deviceType string One of the following strings that specifies the type of device on which the desktop application is blocked:

  • PC
  • Server
  • Tablet
  • Unknown
blockType string One of the following strings that specifies the type of block found on the device:

  • Potential Sediment
  • Temporary Sediment
  • Runtime Notification

For more information about these block types and what they mean to developers and users, see the description of the Application blocks report.

architecture string The architecture of the device on which the block exists:

  • ARM64
  • X86
targetOs string One of the following strings that specifies the Windows 10 OS release on which the desktop application is blocked from running:

  • Version 1709
  • Version 1803
deviceCount number The number of distinct devices that have blocks at the specified aggregation level.

Response example

The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
     "applicationId": "10238467886765136388",
     "date": "2018-06-03",
     "productName": "Contoso Demo",
     "fileName": "contosodemo.exe",
     "applicationVersion": "2.2.2.0",
     "osVersion": "Windows 8.1",
     "osRelease": "Update 1",
     "market": "ZA",
     "deviceType": "All",
     "blockType": "Runtime Notification",
     "architecture": "X86",
     "targetOs": "RS4",
     "deviceCount": 120
    }
  ],
  "@nextLink": "desktop/blockdetails?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
  "TotalCount": 23012
}