获取应用中的错误的详细信息

在 Microsoft Store Analytics API 中使用此方法,以获取 JSON 格式的应用的特定错误的详细数据。 此方法只能检索过去 30 天内发生的错误的详细信息。 还可以在合作伙伴中心的运行状况报告的“故障”部分中获取详细错误数据

在使用此方法之前,必须先使用 get 错误报告数据 方法来检索要获取其详细信息的错误 ID。

先决条件

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

  • 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
  • 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 该令牌到期后,可以获取新的令牌。
  • 获取要获取详细信息的错误的 ID。 若要获取此 ID,请使用 get 错误报告数据 方法,并在该方法的响应正文中使用 failureHash 值。

请求

请求语法

方法 请求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failuredetails

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

参数 类型 描述 必需
applicationId string 要为其检索详细错误数据的应用的应用商店 ID。 存储 ID 在合作伙伴中心的应用标识页上提供。 Store ID 示例:9WZDNCRFJ3Q8。
failureHash string 要获取详细信息的错误的唯一 ID。 若要获取你感兴趣的错误的此值,请使用 get 错误报告数据 方法,并在该方法的响应正文中使用 failureHash 值。
startDate date 要检索的详细错误数据的日期范围内的开始日期。 默认值为当前日期之前的 30 天。

注意:此方法仅可以检索过去 30 天内发生的错误的详细信息。
endDate date 要检索的详细错误数据的日期范围内的结束日期。 默认是当前日期。
top int 要在请求中返回的数据行数。 如果未指定,最大值和默认值为 10000。 当查询中存在多行数据时,响应正文中包含的下一个链接可用于请求下一页数据。
skip int 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如,top=10 和 skip=0 检索前 10 行的数据,top=10 和 skip=10 检索接下来的 10 行数据,依此等。
filter string 在响应中筛选行的一条或多条语句。 每条语句包含的响应正文中的字段名称和值使用 eqne 运算符进行关联,并且语句可以使用 andor 进行组合。 filter 参数中的字符串值必须使用单引号引起来。 可以指定响应正文中的以下字段:

  • market
  • date
  • cabId
  • cabExpirationTime
  • deviceType
  • deviceModel
  • osVersion
  • osRelease
  • packageVersion
  • osBuild
orderby string 对结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...,其中 field 参数可以是以下字符串之一:
  • market
  • date
  • cabId
  • cabExpirationTime
  • deviceType
  • deviceModel
  • osVersion
  • osRelease
  • packageVersion
  • osBuild

order 参数是可选的,可以是 ascdesc,用于指定每个字段的升序或降序排列。 默认值为 asc

下面是一个 orderby 字符串的示例:orderby=date,market

请求示例

以下示例演示了获取详细错误数据的多个请求。 将 applicationId 值替换为你的应用的 Store ID。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failuredetails?applicationId=9NBLGGGZ5QDR&failureHash=012e33e3-dbc9-b12f-c124-9d9810f05d8b&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failuredetails?applicationId=9NBLGGGZ5QDR&failureHash=012e33e3-dbc9-b12f-c124-9d9810f05d8b&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0&filter=market eq 'US' and deviceType eq 'Windows.Desktop' HTTP/1.1
Authorization: Bearer <your access token>

响应

响应正文

类型 说明
Value array 包含详细错误数据的对象的数组。 有关每个对象中的数据的详细信息,请参阅 下面的错误详细信息值 部分。
@nextLink string 如果存在其他数据页,则此字符串包含一个你可用来请求下一页数据的 URI。 例如,当请求的 top 参数设置为 10,但查询的错误超过 10 行时,就会返回此值。
TotalCount integer 查询的数据结果中的行总数。

错误详细信息值

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

Value 类型 说明
applicationId string 检索到详细错误数据的应用的应用商店 ID。
failureHash string 错误的唯一标识符。
failureName string 故障的名称,它由四个部分组成:一个或多个问题类、异常/bug 检查代码、发生故障的映像的名称和相关的函数名称。
date string 错误数据的日期范围内的第一个日期。 如果请求指定了某一天,此值就是该日期。 如果请求指定了一周、月或其他日期范围,此值是该日期范围内的第一个日期。
cabId string 与此错误关联的 CAB 文件的唯一 ID。
cabExpirationTime string CAB 文件过期且无法再下载的日期和时间(采用 ISO 8601 格式)。
market string 设备市场的 ISO 3166 国家/地区代码。
osBuild string 发生错误的 OS 的内部版本号。
packageVersion string 与此错误关联的应用包的版本。
deviceModel string 一个字符串,指定发生错误时应用正在运行的设备型号。
osVersion string 以下字符串之一,指示发生错误的 OS 版本:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
osRelease string 用于指定发生错误的操作系统版本或外部测试 Ring(作为操作系统版本内的亚组)的以下字符串之一。

对于 Windows 11:版本 2110

对于 Windows 10:

  • 版本 1507
  • 版本 1511
  • 版本 1607
  • 版本 1703
  • 版本 1709
  • 版本 1803
  • 预览版
  • 预览体验成员 - 快
  • 预览体验成员 - 慢

对于 Windows Server 1709:

  • RTM

对于 Windows Server 2016:

  • 版本 1607

对于 Windows 8.1:

  • Update 1

对于 Windows 7:

  • 服务包 1

如果 OS 版本或外部测试圈未知,则此字段具有“未知”值。

deviceType string 以下字符串之一,指定发生错误时应用正在运行的设备的类型:
  • 电脑
  • Phone
  • Console-Xbox One
  • Console-Xbox 系列 X
  • IoT
  • Holographic
  • Unknown
cabDownloadable 布尔 指示 CAB 文件是否可供此用户下载。

注意

此方法只能检索过去 30 天内发生的错误的详细信息。

请求和响应示例

如下代码片段展示了这些请求的一些示例请求和 JSON 响应正文。

示例请求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failuredetails?applicationId=9NBLGGGZ5QDR&failureHash=012345-5dbc9-b12f-c124-9d9810f05d8b&startDate=2022-06-30&endDate=2022-07-28&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

示例响应

{
    "Value": [
        {
            "date": "2022-07-12 00:00:00",
            "cabExpirationTime": "2022-08-16 01:37:00",
            "cabDownloadable": false,
            "applicationId": "9NBLGGGZ5QDR",
            "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
            "failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
            "cabId": "1180087848576586304",
            "market": "MX",
            "osBuild": "10.0.19043",
            "packageVersion": "2.5.2.34894",
            "deviceModel": "Dell Inc.-Inspiron 15-3567",
            "osVersion": "Windows 10",
            "osRelease": "Version 21H1",
            "osArchitecture": "x64",
            "deviceType": "PC",
            "cpuManufacturer": "Intel",
            "cpuFamilyName": "Core i5",
            "cpuName": "Intel Core i5-7200U CPU @ 2.50GHz",
            "praid": "app",
            "flightRing": "",
            "sandboxId": "retail"
        },
        {
            "date": "2022-07-13 00:00:00",
            "cabExpirationTime": "2022-08-17 13:35:53",
            "cabDownloadable": true,
            "applicationId": "9NBLGGGZ5QDR",
            "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
            "failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
            "cabId": "2058585545558157474",
            "market": "RO",
            "osBuild": "10.0.22622",
            "packageVersion": "2.5.2.34894",
            "deviceModel": "Dell Inc.-Vostro 5502",
            "osVersion": "Windows 11",
            "osRelease": "External",
            "osArchitecture": "x64",
            "deviceType": "PC",
            "cpuManufacturer": "Intel",
            "cpuFamilyName": "Core i5",
            "cpuName": "11th Gen Intel Core i5-1135G7 @ 2.40GHz",
            "praid": "app",
            "flightRing": "external",
            "sandboxId": "retail"
        },
        {
            "date": "2022-07-14 00:00:00",
            "cabExpirationTime": "2022-08-18 07:27:06",
            "cabDownloadable": false,
            "applicationId": "9NBLGGGZ5QDR",
            "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
            "failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
            "cabId": "1940204079766793391",
            "market": "IN",
            "osBuild": "10.0.19044",
            "packageVersion": "2.5.2.34894",
            "deviceModel": "Generic Desktop",
            "osVersion": "Windows 10",
            "osRelease": "Version 21H2",
            "osArchitecture": "x64",
            "deviceType": "PC",
            "cpuManufacturer": "Intel",
            "cpuFamilyName": "Pentium",
            "cpuName": "Intel Pentium CPU G630 @ 2.70GHz",
            "praid": "app",
            "flightRing": "",
            "sandboxId": "retail"
        },
        {
            "date": "2022-07-17 00:00:00",
            "cabExpirationTime": "2022-08-21 10:04:16",
            "cabDownloadable": true,
            "applicationId": "9NBLGGGZ5QDR",
            "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
            "failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
            "cabId": "1197051093472061859",
            "market": "ES",
            "osBuild": "10.0.22621",
            "packageVersion": "2.5.2.34894",
            "deviceModel": "Microsoft Corporation-Surface Pro 3",
            "osVersion": "Windows 11",
            "osRelease": "External",
            "osArchitecture": "x64",
            "deviceType": "PC",
            "cpuManufacturer": "Intel",
            "cpuFamilyName": "Core i7",
            "cpuName": "Intel Core i7-4650U CPU @ 1.70GHz",
            "praid": "app",
            "flightRing": "external",
            "sandboxId": "retail"
        },
        {
            "date": "2022-07-20 00:00:00",
            "cabExpirationTime": "2022-08-24 12:40:05",
            "cabDownloadable": false,
            "applicationId": "9NBLGGGZ5QDR",
            "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
            "failureName": "MOAPPLICATION_HANG_cfffffff_Microsoft.Contoso!HANG_QUIESCE",
            "cabId": "1332886311327579782",
            "market": "RU",
            "osBuild": "6.3.9600",
            "packageVersion": "2.5.2.34894",
            "deviceModel": "ASUSTeK COMPUTER INC.-K75VJ",
            "osVersion": "Windows 8.1",
            "osRelease": "RTM",
            "osArchitecture": "x64",
            "deviceType": "PC",
            "cpuManufacturer": "Intel",
            "cpuFamilyName": "Core i7",
            "cpuName": "Intel Core i7-3630QM CPU @ 2.40GHz",
            "praid": "app",
            "flightRing": "",
            "sandboxId": ""
        }
    ],
    "TotalCount": 5
}