Obtenir les données de signalement d’erreurs pour votre application de bureau

  • Article

Utilisez cette méthode dans l’API d’analyse de la Boutique Microsoft pour obtenir des données de rapport d’erreurs agrégées pour une application bureautique que vous avez ajoutée au programme d’application de bureau Windows. Cette méthode ne peut récupérer que les erreurs qui se sont produites au cours des 30 derniers jours. Ces informations sont également disponibles dans le rapport d’intégrité pour les applications de bureau dans l’Espace partenaires.

Prérequis

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :

  • Si ce n’est pas déjà fait, remplissez toutes les conditions préalables relatives à l’API d’analyse de la Boutique Microsoft.
  • Obtenir un jeton d’accès Azure AD à utiliser dans l’en-tête de requête pour cette méthode. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire. Une fois le jeton expiré, vous pouvez en obtenir un nouveau.

Requête

Syntaxe de la requête

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

En-tête de requête

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD au format porteur<jeton>.

Paramètres de la demande

Paramètre Type Description Obligatoire
applicationId string ID produit de l’application bureautique pour laquelle vous souhaitez récupérer les données de rapport d’erreurs. Pour obtenir l’ID produit d’une application de bureau, ouvrez un rapport d’analyse pour votre application bureautique dans l’Espace partenaires (tel que le rapport d’intégrité) et récupérez l’ID produit à partir de l’URL. Oui
startDate date Date de début dans la plage de dates des données de rapport d’erreurs à récupérer, au format mm/dd/yyyy. La valeur par défaut est la date actuelle.

Remarque : Cette méthode ne peut récupérer que les erreurs qui se sont produites au cours des 30 derniers jours.		 Non
endDate date Date de fin dans la plage de dates des données de rapport d’erreurs à récupérer, au format mm/dd/yyyy. La valeur par défaut est la date actuelle. Non
haut int Nombre de lignes de données à retourner dans la requête. La valeur maximale, soit la valeur par défaut, est 10000 (si cette valeur n’est pas spécifiée). S’il existe plus de lignes dans la requête, le corps de la réponse inclut un lien suivant que vous pouvez utiliser pour demander la page suivante de données. Non
skip int Nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir des jeux de données volumineux. Par exemple, top=10000 et skip=0 récupère les 10000 premières lignes de données, top=10000 et skip=10000 récupère les 10000 lignes de données suivantes, et ainsi de suite. Non
filter string Une ou plusieurs instructions qui filtrent les lignes dans la réponse. Chaque instruction contient un nom de champ à partir du corps de la réponse et une valeur associés aux opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide et ou ou. Les valeurs de chaîne doivent être entourées de guillemets simples dans le paramètre de filtre. Vous pouvez spécifier les champs suivants à partir du corps de la réponse :

  • fileName
  • applicationVersion
  • failureName
  • failureHash
  • symbole
  • osVersion
  • osBuild
  • osRelease
  • eventType
  • market
  • deviceType
  • productName
  • date
 Non
aggregationLevel string Spécifie l’intervalle de temps pour lequel récupérer des données agrégées. Il peut s’agir de l’une des chaînes suivantes : jour, semaine ou mois. Si aucune valeur n’est spécifiée, la valeur par défaut est jour. Si vous spécifiez une semaine ou un mois, les valeurs failureName et failureHash sont limitées à 1000 compartiments.

 Non
orderby string Instruction qui commande les valeurs de données de résultat. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes :
  • fileName
  • applicationVersion
  • failureName
  • failureHash
  • symbole
  • osVersion
  • osBuild
  • osRelease
  • eventType
  • market
  • deviceType
  • productName
  • date
Le paramètre d’ordre est facultatif et peut être asc ou desc pour spécifier l’ordre croissant ou décroissant pour chaque champ. La valeur par défaut est asc.

Voici un exemple de chaîne orderby : orderby=date,market

 Non
groupby string Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Spécifiez les champs suivants :
  • failureName
  • failureHash
  • symbole
  • osVersion
  • eventType
  • market
  • deviceType

Les lignes de données retournées contiennent les champs spécifiés dans le paramètre groupby, ainsi que les éléments suivants :

  • date
  • applicationId
  • applicationName
  • eventCount

Le paramètre groupby peut être utilisé avec le paramètre aggregationLevel. Par exemple : &groupby=failureName,market&aggregationLevel=week

 Non

Exemple de requête

Les exemples suivants illustrent plusieurs demandes d’obtention de données de rapport d’erreurs. Remplacez la valeur applicationId par l’ID produit pour votre application bureautique.

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>

Response

Response body

Valeur Type Description
active tableau Tableau d’objets qui contiennent des données de rapport d’erreurs agrégées. Pour plus d’informations sur les données de chaque objet, consultez la section valeurs d’erreur ci-dessous.
@nextLink string S’il existe des pages de données supplémentaires, cette chaîne contient un URI que vous pouvez utiliser pour demander la page suivante des données. Par exemple, cette valeur est retournée si le paramètre supérieur de la requête est défini sur 10000, mais qu’il existe plus de 10000 lignes d’erreurs pour la requête.
TotalCount entier Nombre total de lignes dans le résultat des données de la requête.

Valeurs d’erreur

Les éléments du tableau Valeur contiennent les valeurs suivantes.

Valeur Type Description
date string Première date de la plage de dates pour les données d’erreur, au format yyyy-mm-dd. Si la requête spécifie un jour unique, cette valeur est cette date. Si la requête spécifie une plage de dates plus longue, cette valeur est la première date de cette plage de dates. Pour les requêtes qui spécifient une valeur aggregationLevel d’heure, cette valeur inclut également une valeur de temps au format hh:mm:ss.
applicationId string ID produit de l’application bureautique pour laquelle vous avez récupéré les données d’erreur.
productName string Nom complet de l’application bureautique comme dérivé des métadonnées de son ou ses exécutables associés.
appName string À définir
fileName string Le nom du fichier exécutable pour l’application bureautique.
failureName string Nom de l’échec, constitué de quatre parties : une ou plusieurs classes de problème, un code d’exception/code de vérification de bogue, le nom de l’image où l’échec s’est produit et le nom de la fonction associée.
failureHash string Identificateur unique de l’erreur.
symbole string Symbole affecté à cette erreur.
osBuild string Numéro de build en quatre parties du système d’exploitation sur lequel l’erreur s’est produite.
osVersion string L’une des chaînes suivantes qui spécifie la version du système d’exploitation sur laquelle l’application bureautique est installée :

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Inconnu
osRelease string Une des chaînes suivantes qui spécifie la version du système d’exploitation ou la boucle de distribution de versions d’évaluation (sous-remplissage dans la version du système d’exploitation) sur laquelle l’erreur s’est produite.

Pour Windows 11 : Version 2110

Pour Windows 10 :

  • Version 1507
  • Version 1511
  • Version 1607
  • Version 1703
  • Version 1709
  • Version 1803
  • Préversion
  • Insider Rapide
  • Insider Lent

Pour Windows Server 1709 :

  • RTM

Pour Windows Server 2016 :

  • Version 1607

Pour Windows 8.1 :

  • Update 1

Pour Windows 7 :

  • Service Pack 1

Si la version du système d’exploitation ou la boucle de distribution de versions d’évaluation est inconnue, ce champ a la valeur Inconnu.
eventType string Une des chaînes suivantes qui indique le type d’événement d’erreur :
  • crash
  • hang
  • memory
  • jse
market string Code pays ISO 3166 du marché de l’appareil.
deviceType string Une des chaînes suivantes qui spécifie le type d’appareil sur lequel l’erreur s’est produite :

  • PC
  • Serveur
  • Tablette
  • Inconnu
applicationVersion string Version de l’application exécutable dans laquelle l’erreur s’est produite.
eventCount number Nombre d’événements attribués à cette erreur pour le niveau d’agrégation spécifié.

Exemple de réponse

L’exemple suivant illustre un exemple de corps de réponse JSON pour cette requête.

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