获取桌面应用程序的错误报告数据

2025-06-10

在 Microsoft 应用商店分析 API 中使用此方法可获取已添加到 Windows 桌面应用程序程序的桌面应用程序的聚合错误报告数据。此方法只能检索过去 30 天内发生的错误。合作伙伴中心桌面应用程序的运行状况报告中也提供了此信息。

先决条件

若要使用此方法，首先需要执行以下操作：

完成 Microsoft Store 分析 API 的所有先决条件（如果尚未这样做）。
获取 Azure AD 访问令牌，以供在此方法的请求标头中使用。获取访问令牌后，在它到期前，你有 60 分钟的使用时间。令牌过期后，可以获取一个新令牌。

请求

请求语法

方法	请求 URI
获取	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits`

请求标头

标题	类型	DESCRIPTION
授权	字符串	必填。 Azure AD 访问令牌，形式为Bearer<token>。

请求参数

参数	类型	DESCRIPTION	必选
应用ID	字符串	要为其检索错误报告数据的桌面应用程序的产品 ID。若要获取桌面应用程序的产品 ID，请在合作伙伴中心（如运行状况报告）中打开桌面应用程序的任何分析报告，并从 URL 检索产品 ID。	是的
开始日期	日期	要检索的错误报告数据的日期范围内的开始日期，格式为 `mm/dd/yyyy`。默认值为当前日期。注意：此方法只能检索过去 30 天内发生的错误。	否
结束日期	日期	要检索的错误报告数据的日期范围内的结束日期，格式为 `mm/dd/yyyy`。默认值为当前日期。	否
顶部	整数 (int)	请求中要返回的数据行数。如果未指定，则最大值和默认值为 10000。如果查询中有更多行，响应正文将包含下一个链接，可用于请求下一页的数据。	否
跳过	整数 (int)	查询中要跳过的行数。使用此参数可分页浏览大型数据集。例如，top=10000 和 skip=0 检索前 10000 行数据，top=10000 和 skip=10000 检索接下来的 10000 行数据，依此等。	否
过滤器	字符串	一个或多个用于筛选响应中行的语句。每个语句都包含响应正文中的字段名称和值，这些字段名称与 eq 或 ne 运算符相关联，语句可以使用和、或进行组合。字符串值必须用筛选器参数中的单引号括起来。可以从响应正文中指定以下字段：文件名应用程序版本 failureName failureHash 符号操作系统版本 osBuild osRelease eventType 市场设备类型 productName 日期	否
聚合级别	字符串	指定要检索聚合数据的时间范围。可以是以下字符串之一：day、week 或 month。如果未指定，默认值为 day。如果指定周或月，则 failureName 和 failureHash 的值限制为 1000 个桶。	否
排序	字符串	对结果数据值进行排序的语句。语法为 orderby=field [order]，field [order]，...。字段参数可以是以下字符串之一：文件名应用程序版本 failureName failureHash 符号操作系统版本 osBuild osRelease eventType 市场设备类型 productName 日期顺序参数是可选的，可以是 asc 或 desc 来指定每个字段的升序或降序。默认值为 asc。下面是一个 orderby 字符串的示例：orderby=date,market	否
按组分类	字符串	仅对指定字段应用数据聚合的语句。可以指定以下字段： failureName failureHash 符号操作系统版本 eventType 市场设备类型返回的数据行将包含 groupby 参数中指定的字段，如下所示：日期 applicationId applicationName 事件计数 groupby 参数可与 aggregationLevel 参数一起使用。例如： &groupby=failureName，market&aggregationLevel=week	否

请求示例

以下示例演示了获取错误报告数据的多个请求。将 applicationId 的值替换为桌面应用程序的产品ID。

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>

响应

响应体

价值	类型	DESCRIPTION
价值	数组	包含聚合错误报告数据的对象数组。有关每个对象中的数据的详细信息，请参阅下面的错误值部分。
@nextLink	字符串	如果有其他数据页，此字符串包含可用于请求下一页数据的 URI。例如，如果请求的顶部参数设置为 10000，但查询的错误行数超过 10000 行，则返回此值。
总计数	整数	查询的数据结果中的行总数。

错误值

Value 数组中的元素包含以下值。

价值	类型	DESCRIPTION
日期	字符串	错误数据中的日期范围的第一个日期，格式为 `yyyy-mm-dd`。如果请求指定一天，则此值为该日期。如果请求指定更长的日期范围，则此值是该日期范围中的第一个日期。对于指定 aggregationLevel 值为小时的请求，此数值还包括格式为 `hh:mm:ss`的时间值。
应用ID	字符串	检索错误数据的桌面应用程序的产品 ID。
产品名称	字符串	桌面应用程序的显示名称是从其关联可执行文件的元数据中派生的。
应用名称	字符串	待定
文件名	字符串	桌面应用程序的可执行文件的名称。
故障名称	字符串	失败的名称由四个部分组成：一个或多个问题类、异常/bug 检查代码、发生故障的图像的名称以及关联的函数名称。
故障哈希码	字符串	错误唯一标识符。
象征	字符串	为此错误分配的符号。
osBuild	字符串	发生错误的操作系统的四部分内部版本号。
osVersion	字符串	以下字符串之一，指定安装了桌面应用程序的 OS 版本： Windows 7 Windows 8.1 Windows 10 Windows 11 Windows Server 2016 Windows Server 1709 未知
osRelease	字符串	以下字符串之一，用于指定发生错误的 OS 版本或预发布环（作为 OS 版本中的子组）。适用于 Windows 11：版本 2110 对于 Windows 10：版本 1507 版本 1511 版本 1607 版本 1703 版本 1709 版本 1803 发布预览内部人士快速版内部消息缓慢对于 Windows Server 1709： RTM 对于 Windows Server 2016：版本 1607 对于 Windows 8.1：更新 1 对于 Windows 7：服务包 1 如果操作系统版本或飞行环未知，此字段的值为未知。
事件类型	字符串	以下字符串之一，指示错误事件的类型：崩溃挂起记忆 jse
市场	字符串	设备市场的 ISO 3166 国家/地区代码。
设备类型	字符串	以下字符串之一，指定发生错误的设备的类型：个人电脑服务器平板电脑未知
应用程序版本	字符串	发生错误的应用程序可执行文件的版本。
事件计数	数字	该指定聚合级别中因该错误而归因的事件数。

响应示例

以下示例演示此请求的示例 JSON 响应正文。

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

通过