get-oem-hardware-error-reporting-data.md

author	ms.assetid	description	title	ms.author	ms.date	ms.topic	ms.prod	ms.technology	keywords	ms.localizationpriority
mcleanbyron	AE3E003F-BDEC-438B-A80A-3CE1675B369C	Use this method in the Microsoft Store analytics API to get aggregate hardware error reporting data for a given date range and other optional filters. This method is intended only for OEMs.	Get OEM hardware error reporting data	mcleans	01/18/2018	article	windows	uwp	windows 10, uwp, Store services, Microsoft Store analytics API, errors	medium

Get OEM hardware error reporting data

Use this method in the Microsoft Store analytics API to get aggregate reporting data for OEM hardware errors for a given date range and other optional filters. You can retrieve additional error information by using the get details for an OEM hardware error method.

Note

This method can only be used by developer accounts that belong to the Windows Hardware Dev Center program.

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/hardware/failurehits

 

Request header

Header	Type	Description
Authorization	string	Required. The Azure AD access token in the form Bearer <token>.

 

Request parameters

Parameter	Type	Description	Required
startDate	date	The start date in the date range of error reporting data to retrieve. The default is the current date.	No
endDate	date	The end date in the date range of error reporting 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: failureName failureHash symbol osVersion eventType market deviceType moduleName moduleVersion mode architecture model baseboard modelFamily flightRing	No
aggregationLevel	string	Specifies the time range for which to retrieve aggregate data. Can be one of the following strings: day, week, or month. If unspecified, the default is day. If you specify week or month, the failureName and failureHash values are limited to 1000 buckets.	No
orderby	string	A statement that orders the result data values. The syntax is orderby=field [order],field [order],.... You can specify the following fields from the response body: date failureName failureHash symbol osVersion eventType market deviceType moduleName moduleVersion mode architecture model baseboard modelFamily flightRing 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: failureName failureHash symbol osVersion eventType market deviceType moduleName moduleVersion mode architecture model baseboard modelFamily flightRing The returned data rows will contain the fields specified in the groupby parameter as well as the following: date eventCount The groupby parameter can be used with the aggregationLevel parameter. For example: &groupby=failureName,market&aggregationLevel=week	No

Request example

The following examples demonstrate several requests for getting OEM hardware error reporting data.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/hardware/failurehits?startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/hardware/failurehits?startDate=8/1/2015&endDate=8/31/2015&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 aggregate error reporting 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 errors for the query.
TotalCount	inumber	The total number of rows in the data result for the query.

Elements in the Value array contain the following values.

Value	Type	Description
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.
sellerId	string	The seller ID value that is associated with the developer account (this matches the Seller ID value in the Dev Center account settings).
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/driver where the failure occurred, and the associated function name.
failureHash	string	The unique identifier for the error.
symbol	string	The symbol assigned to this error.
osVersion	string	The four-part build version of the OS on which the error occurred.
eventType	string	The type of the error that occurred.
market	string	The ISO 3166 country code of the device market.
deviceType	string	One of the following strings that specifies the type of device on which the error occurred: PC Phone Console IoT Holographic Unknown
moduleName	string	The unique name of the module that is associated with this error.
moduleVersion	string	The version of the module that is associated with this error.
architecture	string	The architecture of the device on which the error occurred.
model	string	The name of the device model on which the error occurred.
baseboard	string	The name of the device baseboard on which the error occurred.
modelFamily	string	The name of the device model family on which the error occurred.
flightRing	string	The name of the OS flight on which the error occurred.
mode	string	This value is always kernel.
eventCount	inumber	The number of events that are attributed to this error for the specified aggregation level.

 

Response example

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

{
  "Value": [
    {
      "date": "2017-02-18",
      "sellerId": "14313740",
      "mode": "Kernel",
      "failureName": "AV_wfplwfs!L2802_3ParseMacHeader",
      "failureHash": "f060c0b6-fbe6-463f-a9f1-b7ebc1cc722f",
      "symbol": "wfplwfs!L2802_3ParseMacHeader",
      "osVersion": "10.0.14393.0",
      "eventType": "System crash",
      "market": "US",
      "deviceType": "PC",
      "moduleName": "wfplwfs.sys",
      "moduleVersion": "10.0.14393.0",
      "architecture": "x64",
      "model": "Unknown",
      "baseboard": "Unknown",
      "modelFamily": "ContosoPad",
      "flightRing": "Windows 10 Retail",
      "eventCount": 2.0
    }]
}

Related topics

• Get details for an OEM hardware error
• Download the CAB file for an OEM hardware error