Get details for an error in your desktop application
Use this method in the Microsoft Store analytics API to get detailed data for a specific error for your app in JSON format. This method can only retrieve details for errors that occurred in the last 30 days. Detailed error data is also available in the Health report for desktop applications in Partner Center.
Before you can use this method, you must first use the get error reporting data method to retrieve the ID of the error for which you want to get detailed info.
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.
- Get the ID of the error for which you want to get detailed info. To get this ID, use the get error reporting data method and use the failureHash value in the response body of that method.
Request
Request syntax
| Method | Request URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails |
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 error details. To get the product ID of a desktop application, open any analytics report for your desktop application in Partner Center (such as the Health report) and retrieve the product ID from the URL. | Yes |
| failureHash | string | The unique ID of the error for which you want to get detailed info. To get this value for the error you are interested in, use the get error reporting data method and use the failureHash value in the response body of that method. | Yes |
| startDate | date | The start date in the date range of detailed error data to retrieve. The default is 30 days before the current date.Note: This method can only retrieve details for errors that occurred in the last 30 days. | No |
| endDate | date | The end date in the date range of detailed error 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=10 and skip=0 retrieves the first 10 rows of data, top=10 and skip=10 retrieves the next 10 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:
|
No |
| orderby | string | A statement that orders the result data values. 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 |
Request example
The following examples demonstrate several requests for getting detailed error data. Replace the applicationId value with the product ID for your desktop application.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=00001111-aaaa-2222-bbbb-3333cccc4444&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=00001111-aaaa-2222-bbbb-3333cccc4444&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0&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 detailed error data. For more information about the data in each object, see the error detail 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 10 but there are more than 10 rows of errors for the query. |
| TotalCount | integer | The total number of rows in the data result for the query. |
Error detail values
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 error details. |
| failureHash | string | The unique identifier for the error. |
| failureName | string | The name of the failure, which is made up of four parts: one or more problem classes, an exception/bug check code, the name of the image where the failure occurred, and the associated function name. |
| date | string | The first date in the date range for the error 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. |
| cabIdHash | string | The unique ID hash of the CAB file that is associated with this error. |
| cabExpirationTime | string | The date and time when the CAB file is expired and can no longer be downloaded, in ISO 8601 format. |
| market | string | The ISO 3166 country code of the device market. |
| osBuild | string | The build number of the OS on which the error occurred. |
| applicationVersion | string | The version of the application executable in which the error occurred. |
| deviceModel | string | A string that specifies the model of the device on which the app was running when the error occurred. |
| osVersion | string | One of the following strings that specifies the OS version on which the desktop application is installed:
|
| osRelease | string | One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the error occurred. For Windows 11: Version 2110 For Windows 10:
For Windows Server 1709:
For Windows Server 2016:
For Windows 8.1:
For Windows 7:
If the OS release or flighting ring is unknown, this field has the value Unknown. |
| deviceType | string | One of the following strings that indicates the type of device on which the error occurred:
|
| cabDownloadable | Boolean | Indicates whether the CAB file is downloadable for this user. |
| fileName | string | The name of the executable file for the desktop application for which you retrieved error details. |
Response example
The following example demonstrates an example JSON response body for this request.
{
"Value": [
{
"applicationId": "10238467886765136388",
"failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
"failureName": "NULL_CLASS_PTR_WRITE_c0000005_contoso.exe!unknown_error_in_process",
"date": "2018-01-28 23:55:29",
"cabIdHash": "54ffb83a-e159-41d2-8158-f36f306cc01e",
"cabExpirationTime": "2018-02-27 23:55:29",
"market": "US",
"osBuild": "10.0.10240",
"applicationVersion": "2.2.2.0",
"deviceModel": "Contoso All-in-one",
"osVersion": "Windows 10",
"osRelease": "Version 1703",
"deviceType": "PC",
"cabDownloadable": false,
"fileName": "contosodemo.exe"
}
],
"@nextLink": null,
"TotalCount": 1
}