Obtener datos de informes de errores de la aplicación de escritorioGet error reporting data for your desktop application

Use este método en la API de Microsoft Store Analytics para obtener datos de informes de errores agregados para una aplicación de escritorio que haya agregado al programa de aplicación de escritorio de Windows.Use this method in the Microsoft Store analytics API to get aggregate error reporting data for a desktop application that you have added to the Windows Desktop Application program. Este método solo puede recuperar los errores que se produjeron en los últimos 30 días.This method can only retrieve errors that occurred in the last 30 days. Esta información también está disponible en el Informe de mantenimiento de las aplicaciones de escritorio del centro de Partners.This information is also available in the Health report for desktop applications in Partner Center.

Requisitos previosPrerequisites

Para usar este método, primero debes hacer lo siguiente:To use this method, you need to first do the following:

  • Si aún no lo ha hecho, complete todos los requisitos previos de la API de Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método.Obtain an Azure AD access token to use in the request header for this method. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits

Encabezado de solicitudRequest header

EncabezadoHeader TipoType DescripciónDescription
AuthorizationAuthorization stringstring Necesario.Required. El token de acceso de Azure AD del formulario Bearer <token>.The Azure AD access token in the form Bearer <token>.

Parámetros de solicitudRequest parameters

ParámetroParameter TipoType DescripciónDescription ObligatorioRequired
applicationIdapplicationId stringstring El ID. de producto de la aplicación de escritorio para la que desea recuperar datos de informes de errores.The product ID of the desktop application for which you want to retrieve error reporting data. Para obtener el identificador de producto de una aplicación de escritorio, abra el Informe de análisis de la aplicación de escritorio en el centro de Partners (como el Informe de mantenimiento) y recupere el identificador de producto de la dirección URL.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
startDatestartDate datedate Fecha de inicio del intervalo de fechas de los datos de informes de errores que se van a recuperar, en el formato mm/dd/yyyy .The start date in the date range of error reporting data to retrieve, in the format mm/dd/yyyy. La fecha predeterminada es la actual.The default is the current date.

Nota:     Este método solo puede recuperar los errores que se produjeron en los últimos 30 días.Note:  This method can only retrieve errors that occurred in the last 30 days.

NoNo
endDateendDate datedate Fecha de finalización del intervalo de fechas de los datos de informes de errores que se van a recuperar, en el formato mm/dd/yyyy .The end date in the date range of error reporting data to retrieve, in the format mm/dd/yyyy. La fecha predeterminada es la actual.The default is the current date. NoNo
toptop intint Número de filas de datos que se devuelven en la solicitud.The number of rows of data to return in the request. El valor máximo y el valor predeterminado, si no se especifican, es 10 000.The maximum value and the default value if not specified is 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo que puedes usar para solicitar la siguiente página de datos.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. NoNo
skipskip intint Número de filas que se omiten en la consulta.The number of rows to skip in the query. Usa este parámetro para consultar grandes conjuntos de datos.Use this parameter to page through large data sets. Por ejemplo, los valores top=10000 y skip=0 recuperan las primeras 10 000 filas de datos, los valores top=10000 y skip=10000 recuperan las siguientes 10 000 filas de datos, y así sucesivamente.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. NoNo
filterfilter stringstring Una o más instrucciones que filtran las filas de la respuesta.One or more statements that filter the rows in the response. Cada instrucción contiene un nombre de campo del cuerpo de la respuesta y el valor que están asociados a los operadores EQ o ne , y las instrucciones se pueden combinar con and u or.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. Ten en cuenta que en el parámetro filter los valores de la cadena deben estar entre comillas simples.String values must be surrounded by single quotes in the filter parameter. Puede especificar los siguientes campos del cuerpo de la respuesta:You can specify the following fields from the response body:

  • fileNamefileName
  • applicationVersionapplicationVersion
  • failureNamefailureName
  • failureHashfailureHash
  • símbolosymbol
  • osVersionosVersion
  • osBuildosBuild
  • osReleaseosRelease
  • eventTypeeventType
  • datamarketmarket
  • deviceTypedeviceType
  • NombreDeProductoproductName
  • datedate
NoNo
aggregationLevelaggregationLevel stringstring Especifica el intervalo de tiempo necesario para el que quieres recuperar datos agregados.Specifies the time range for which to retrieve aggregate data. Puede ser una de las siguientes cadenas: día, semana o mes.Can be one of the following strings: day, week, or month. Si no se especifica, el valor predeterminado es día.If unspecified, the default is day. Si especificas los valores semana o mes, los valores failureName y failureHash se limitarán a 1000 depósitos.If you specify week or month, the failureName and failureHash values are limited to 1000 buckets.

NoNo
orderbyorderby stringstring Una instrucción que ordena los valores de datos resultantes.A statement that orders the result data values. La sintaxis es OrderBy = Field [order], Field [order],.... El parámetro de campo puede ser una de las cadenas siguientes:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • fileNamefileName
  • applicationVersionapplicationVersion
  • failureNamefailureName
  • failureHashfailureHash
  • símbolosymbol
  • osVersionosVersion
  • osBuildosBuild
  • osReleaseosRelease
  • eventTypeeventType
  • datamarketmarket
  • deviceTypedeviceType
  • NombreDeProductoproductName
  • datedate
El parámetro order, en cambio, es opcional y puede ser asc o desc para especificar el orden ascendente o descendente de cada campo.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. El valor predeterminado es ASC.The default is asc.

Este es un ejemplo de cadena OrderBy : OrderBy = Date, MarketHere is an example orderby string: orderby=date,market

NoNo
groupbygroupby stringstring Una instrucción que aplica la agregación de datos únicamente a los campos especificados.A statement that applies data aggregation only to the specified fields. Puedes especificar los siguientes campos:You can specify the following fields:
  • failureNamefailureName
  • failureHashfailureHash
  • símbolosymbol
  • osVersionosVersion
  • eventTypeeventType
  • datamarketmarket
  • deviceTypedeviceType

Las filas de datos que se devuelvan contendrán los campos especificados en el parámetro groupby y en los siguientes:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • applicationNameapplicationName
  • eventCounteventCount

Puedes usar el parámetro groupby con aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Por ejemplo: * & GroupBy = failureName, Market & aggregationLevel = Week*For example: &groupby=failureName,market&aggregationLevel=week

NoNo

Ejemplo de solicitudRequest example

Los siguientes ejemplos muestran varias solicitudes para obtener los datos del informe de errores.The following examples demonstrate several requests for getting error reporting data. Reemplace el valor de ApplicationID por el ID. de producto de la aplicación de escritorio.Replace the applicationId value with the product ID for your desktop application.

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits?applicationId=10238467886765136388&startDate=8/1/2017&endDate=8/31/2017&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

ResponseResponse

Cuerpo de la respuestaResponse body

ValueValue TipoType DescripciónDescription
ValueValue arrayarray Matriz de objetos que contienen los datos agregados del informe de errores.An array of objects that contain aggregate error reporting data. Para obtener más información sobre los datos de cada objeto, consulta la sección valores de error que encontrarás a continuación.For more information about the data in each object, see the error values section below.
@nextLink stringstring Si hay páginas adicionales de datos, esta cadena contiene un URI que puedes usar para solicitar la siguiente página de datos.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Por ejemplo, se devuelve este valor si el parámetro top de la solicitud está establecido en 10 000, pero resulta que hay más de 10 000 filas de errores de la solicitud.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.
TotalCountTotalCount integerinteger El número total de filas del resultado de datos de la consulta.The total number of rows in the data result for the query.

Valores de errorError values

Los elementos de la matriz Value contienen los siguientes valores.Elements in the Value array contain the following values.

ValueValue TipoType DescripciónDescription
datedate stringstring La primera fecha del intervalo de fechas de los datos de error, en el formato yyyy-mm-dd .The first date in the date range for the error data, in the format yyyy-mm-dd. Si la solicitud especifica un solo día, este valor es esa fecha.If the request specifies a single day, this value is that date. Si la solicitud especifica un intervalo de fechas más largo, este valor es la primera fecha del intervalo de fechas.If the request specifies a longer date range, this value is the first date in that date range. En el caso de las solicitudes que especifican un valor de aggregationLevel de hora, este valor también incluye un valor de hora en el formato hh:mm:ss .For requests that specify an aggregationLevel value of hour, this value also includes a time value in the format hh:mm:ss.
applicationIdapplicationId stringstring El ID. del producto de la aplicación de escritorio para la que recuperó los datos de error.The product ID of the desktop application for which you retrieved error data.
ProductNameproductName stringstring Nombre para mostrar de la aplicación de escritorio que se deriva de los metadatos de los archivos ejecutables asociados.The display name of the desktop application as derived from the metadata of its associated executable(s).
appNameappName stringstring TBDTBD
fileNamefileName stringstring Nombre del archivo ejecutable de la aplicación de escritorio.The name of the executable file for the desktop application.
failureNamefailureName stringstring El nombre del error, que se compone de cuatro partes: una o varias clases problemáticas, un código de comprobación de excepción/error, el nombre de la imagen en la que se produjo el error y el nombre de la función asociada.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.
failureHashfailureHash stringstring El identificador único del error.The unique identifier for the error.
símbolosymbol stringstring Símbolo que se asigna al error.The symbol assigned to this error.
osBuildosBuild stringstring Número de compilación de cuatro partes del sistema operativo en el que se produjo el error.The four-part build number of the OS on which the error occurred.
osVersionosVersion stringstring Una de las siguientes cadenas que especifica la versión del sistema operativo en la que se instala la aplicación de escritorio:One of the following strings that specifies the OS version on which the desktop application is installed:

  • Windows 7Windows 7
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • Windows Server 2016Windows Server 2016
  • Windows Server 1709Windows Server 1709
  • UnknownUnknown
osReleaseosRelease stringstring Una de las siguientes cadenas que especifica la versión del sistema operativo o el anillo de vuelo (como un rellenado de la versión del sistema operativo) en el que se produjo el error.One of the following strings that specifies the OS release or flighting ring (as a subpopulation within OS version) on which the error occurred.

Para Windows 10:For Windows 10:

  • Versión 1507Version 1507
  • Versión 1511Version 1511
  • Versión 1607Version 1607
  • Versión 1703Version 1703
  • Versión 1709Version 1709
  • Versión 1803Version 1803
  • Versión preliminarRelease Preview
  • Insider rápidoInsider Fast
  • Insider lentoInsider Slow

Para Windows Server 1709:For Windows Server 1709:

  • VERSIÓNRTM

Para Windows Server 2016:For Windows Server 2016:

  • Versión 1607Version 1607

Para Windows 8.1:For Windows 8.1:

  • Actualización 1Update 1

Para Windows 7:For Windows 7:

  • Service Pack 1Service Pack 1

Si se desconoce la versión del sistema operativo o el anillo de vuelo, este campo tiene el valor desconocido.If the OS release or flighting ring is unknown, this field has the value Unknown.

eventTypeeventType stringstring Una de las siguientes cadenas que indica el tipo de evento de error:One of the following strings that indicates the type of error event:
  • experimentócrash
  • aplicacihang
  • memoriamemory
  • JSEjse
marketmarket stringstring El código de país ISO 3166 del mercado del dispositivo.The ISO 3166 country code of the device market.
deviceTypedeviceType stringstring Una de las siguientes cadenas que especifica el tipo de dispositivo en el que se produjo el error:One of the following strings that specifies the type of device on which the error occurred:

  • PCPC
  • ServerServer
  • TabletaTablet
  • UnknownUnknown
applicationVersionapplicationVersion stringstring Versión del archivo ejecutable de la aplicación en el que se produjo el error.The version of the application executable in which the error occurred.
eventCounteventCount numbernumber Número de eventos atribuidos a este error del nivel de agregación especificado.The number of events that are attributed to this error for the specified aggregation level.

Ejemplo de respuestaResponse example

En el ejemplo siguiente se muestra el cuerpo de una respuesta JSON de ejemplo realizada para esta solicitud.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2018-02-01",
      "applicationId": "10238467886765136388",
      "productName": "Contoso Demo",
      "appName": "Contoso Demo",
      "fileName": "contosodemo.exe",
      "failureName": "SVCHOSTGROUP_localservice_IN_PAGE_ERROR_c0000006_hardware_disk!Unknown",
      "failureHash": "11242ef3-ebd8-d525-838d-b5497b225695",
      "symbol": "hardware_disk!Unknown",
      "osBuild": "10.0.15063.850",
      "osVersion": "Windows 10",
      "osRelease": "Version 1703",
      "eventType": "crash",
      "market": "US",
      "deviceType": "PC",
      "applicationVersion": "2.2.2.0",
      "eventCount": 0.0012422360248447205
    }
  ],
  "@nextLink": "desktop/failurehits?applicationId=10238467886765136388&aggregationLevel=week&startDate=2018/02/01&endDate2018/02/08&top=1&skip=1",
  "TotalCount": 21
}