Obtener datos de informes de errores de la aplicación de escritorio

Usa este método en la API de análisis de Microsoft Store para obtener datos agregados de informes de errores para una aplicación de escritorio que hayas añadido al programa Aplicación de escritorio de Windows. Este método solo puede recuperar errores que se hayan producido en los últimos 30 días. Esta información también está disponible en el informe de estado de las aplicaciones de escritorio en el Centro de partners.

Requisitos previos

Para usar este método, primero debes hacer lo siguiente:

  • Si aún no lo has hecho, completa todos los requisitos previos de la API de análisis de Microsoft Store.
  • Consigue un token de acceso a Azure AD para utilizarlo en el encabezado de solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.

Solicitar

Sintaxis de la solicitud

Método URI de solicitud
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización cadena Necesario. Token de acceso de Azure AD con el formato Token<de portador>.

Parámetros de solicitud

Parámetro Tipo Descripción Obligatorio
applicationId string Identificador de producto de la aplicación de escritorio para la que desean recuperar los datos de informes de errores. Para obtener el identificador de producto de una aplicación de escritorio, abre cualquier informe de análisis de la aplicación de escritorio en el Centro de partners (como el informe de estado) y recupera el identificador de producto de la dirección URL.
startDate date Fecha de inicio del intervalo de fechas de los datos de informes de errores que se van a recuperar, en formato mm/dd/yyyy. La fecha actual es el valor predeterminado.

Nota: Este método solo puede recuperar los errores que se hayan producido en los últimos 30 días.
No
endDate date Fecha de finalización del intervalo de fechas de los datos de informes de errores que se van a recuperar, en formato mm/dd/yyyy. La fecha actual es el valor predeterminado. No
top int Número de filas de datos que se van a devolver en la solicitud. Si no se especifica, el valor predeterminado y el valor máximo es 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo “Siguiente” que puedes usar para solicitar la siguiente página de datos. No
skip int Número de filas que se omiten en la consulta. Usa este parámetro para pasar de página en conjuntos de datos grandes. Por ejemplo, top=10000 y skip=0 recupera las primeras 10000 filas de datos, top=10000 y skip=10000 recupera las siguientes 10000 filas de datos, etc. No
filter string Una o varias instrucciones que filtran las filas de la respuesta. 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 mediante y u o. Los valores de cadena deben estar entre comillas simples en el parámetro de filtro. Puedes especificar los campos siguientes desde el cuerpo de la respuesta:

  • fileName
  • applicationVersion
  • failureName
  • failureHash
  • symbol
  • osVersion
  • osBuild
  • osRelease
  • eventType
  • market
  • deviceType
  • productName
  • date
No
aggregationLevel string Especifica el intervalo de tiempo para el que se van a recuperar los datos agregados. Puede ser una de las siguientes cadenas: día, semana o mes. Si no se especifica nada, el valor predeterminado es día. Si indicas semana o mes, los valores failureName y failureHash están limitados a 1000 depósitos.

No
orderby string Instrucción que ordena los valores de los datos en los resultados. La sintaxis es orderby=field [order],field [order],.... El parámetro field puede estar formado por una de las siguientes cadenas:
  • fileName
  • applicationVersion
  • failureName
  • failureHash
  • symbol
  • osVersion
  • osBuild
  • osRelease
  • eventType
  • market
  • deviceType
  • productName
  • date
El parámetro order es opcional y puede ser asc o desc para especificar el orden ascendente o descendente de cada campo. El valor predeterminado es asc.

Este es un ejemplo de cadena orderby: orderby=date,market

No
groupby string Instrucción que aplica la agregación de datos solo a los campos especificados. Puedes especificar los siguientes campos:
  • failureName
  • failureHash
  • symbol
  • osVersion
  • eventType
  • market
  • deviceType

Las filas de datos devueltas contendrán los campos especificados en el parámetro groupby, además de los siguientes:

  • date
  • applicationId
  • applicationName
  • eventCount

El parámetro groupby se puede usar con el parámetro aggregationLevel. Por ejemplo: &groupby=failureName,market&aggregationLevel=week

No

Ejemplo de solicitud

En los ejemplos siguientes se muestran varias solicitudes para obtener datos de informes de errores. Reeplaza el valor applicationId por el id. del producto de la aplicación de escritorio.

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>

Respuesta

Response body

Valor Tipo Descripción
Value array Matriz de objetos que contienen datos agregados de informes de errores. Para obtener más información sobre los datos de cada objeto, consulta la sección valores de error a continuación.
@nextLink string Si hay páginas adicionales de datos, esta cadena contiene un URI que se puede usar para solicitar la siguiente página de datos. Por ejemplo, este valor se devuelve si se introducce el valor 10000 para el parámetro top de la solicitud, pero hay más de 10000 filas de errores para la consulta.
TotalCount integer Número total de filas que figura en el resultado de datos de la consulta.

Valores del error

Los elementos de la matriz Value contienen los valores siguientes.

Valor Tipo Descripción
date string La primera fecha del intervalo de fechas de los datos de errores, en formato yyyy-mm-dd. Si la solicitud especifica un solo día, este valor es esa fecha. Si la solicitud especifica un intervalo de fechas más largo, este valor es la primera fecha de ese intervalo de fechas. En el caso de las solicitudes que especifican un valor aggregationLevel de hora, este valor también incluye un valor de hora en formato hh:mm:ss.
applicationId string Identificador de producto de la aplicación de escritorio para la que se recuperaron datos de errores.
productName string Nombre para mostrar de la aplicación de escritorio como se deriva de los metadatos de los ejecutables asociados.
appName string TBD
fileName string Nombre del archivo ejecutable de la aplicación de escritorio.
failureName string Nombre del error, que consta de cuatro partes: una o varias clases de problemas, un código de comprobación de errores o excepciones, el nombre de la imagen donde se produjo el error y el nombre de la función asociada.
failureHash string El identificador único del error.
symbol string Símbolo asignado a este error.
osBuild string Número de versión de compilación de cuatro partes del sistema operativo en el que se produjo el error.
osVersion string Una de las siguientes cadenas que especifica la versión del sistema operativo en la que está instalada la aplicación de escritorio:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Desconocido
osRelease string Una de las siguientes cadenas que especifica la versión del sistema operativo o el anillo de distribución de paquetes piloto (como subpoblación dentro de la versión del sistema operativo) en la que se produjo el error.

Para Windows 11: versión 2110

Para Windows 10:

  • Versión 1507
  • Versión 1511
  • Versión 1607
  • Versión 1703
  • Versión 1709
  • Versión 1803
  • Versión preliminar
  • Modo anticipado del Insider
  • Modo aplazado del Insider

Para Windows Server 1709:

  • RTM

Para Windows Server 2016:

  • Versión 1607

Para Windows 8.1:

  • Actualización 1

Para Windows 7:

  • Service Pack 1

Si se desconoce la versión del sistema operativo o el anillo de distribución de paquestes piloto, este campo tiene el valor Desconocido.

eventType string Una de las siguientes cadenas que indica el tipo de evento de error:
  • crash
  • hang
  • memory
  • jse
market string El código de país ISO 3166 del mercado del dispositivo.
deviceType string Una de las siguientes cadenas que especifica el tipo de dispositivo en el que se produjo el error:

  • PC
  • Server
  • Tablet
  • Desconocido
applicationVersion string Versión del ejecutable de la aplicación en la que se produjo el error.
eventCount number Número de eventos que se atribuyen a este error para el nivel de agregación especificado.

Ejemplo de respuesta

En el ejemplo siguiente se muestra un ejemplo de cuerpo de respuesta en formato JSON para esta solicitud.

{
  "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
}