共用方式為


取得應用程式的錯誤報告數據

在 Microsoft 市集分析 API 中使用此方法,以 JSON 格式取得您應用程式的匯總錯誤報告數據,以指定日期範圍和其他選擇性篩選。 此方法只能擷取過去 30 天內發生的錯誤。 此資訊也可以在合作夥伴中心 健康情況報告失敗 一節中找到。

您可以透過 取得錯誤詳細資訊取得堆疊追蹤,以及 下載 CAB 檔案 來擷取其他錯誤資訊。

先決條件

若要使用此方法,您必須先執行下列動作:

  • 如果您尚未這麼做,請完成Microsoft Store 分析 API 的所有 必要條件
  • 取得 Azure AD 存取令牌,以用於此方法的要求標頭中。 取得存取令牌後,您有 60 分鐘的時間在到期之前使用它。 令牌到期之後,您可以取得新的令牌。

請求

要求語法

方法 要求 URI
獲取 https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits

請求標頭

頁眉 類型 描述
授權 字串 必填。 Azure AD 存取令牌的格式為 Bearer<>。

要求參數

參數 類型 描述 必填
applicationId 字串 您想要擷取錯誤報告數據之應用程式的市集標識碼。 商店 ID 可在合作夥伴中心的 應用程式身份頁面 取得。 市集標識符範例為 9WZDNCRFJ3Q8。 是的
開始日期 日期 要擷取的錯誤報告數據日期範圍的起始日期。 預設值為目前的日期。 如果 aggregationLevel,此參數應該以 mm/dd/yyyy格式指定日期。 如果 aggregationLevel小時,此參數可以指定格式為 mm/dd/yyyy 的日期,或格式為 yyyy-mm-dd hh:mm:ss的日期和時間。

注意: 此方法只能擷取過去 30 天內發生的錯誤。
結束日期 日期 要擷取之錯誤報告數據的日期範圍結束日期。 預設值為目前的日期。 如果 aggregationLevel,此參數應該以 mm/dd/yyyy格式指定日期。 如果 aggregationLevel小時,此參數就可以以格式 mm/dd/yyyy 或格式 yyyy-mm-dd hh:mm:ss的日期和時間指定日期。
返回頁首 整數 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多數據列,響應主體會包含下一個連結,您可以用來要求下一頁的數據。
略過 整數 (int) 查詢中要略過的行數。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。
過濾器 字串 篩選回應中數據列的一或多個語句。 每個語句都包含來自回應正文中的欄位名稱和值,與 eqne 運算符相關聯,並且語句可以使用 來結合。 字串值必須以 篩選 參數中的單引號括住。 您可以從回應正文指定下列欄位:

  • applicationName
  • 故障名稱
  • failureHash
  • 符號
  • 操作系統版本
  • osRelease
  • 事件類型
  • 市場
  • 裝置類型
  • packageName
  • packageVersion
  • 日期
聚合層級 字串 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串:小時。 如果未指定,則預設值為 。 如果您指定 ,則 failureNamefailureHash 的值限制為 1000 個桶。

注意: 如果您指定 小時,則只能從前 72 小時取得錯誤數據。 若要擷取超過 72 小時的錯誤數據,請指定 或其他匯總層級之一。
排序 字串 排序結果數據值的語句。 語法為 *orderby=field [order]。 欄位 參數可以是下列字串的一個(且只有一個:
  • applicationName
  • 故障名稱
  • 錯誤雜湊
  • 符號
  • osVersion
  • osRelease
  • eventType
  • 市場
  • 設備類型 (deviceType)
  • packageName
  • 軟體版本
  • 日期

順序 參數是選擇性的,並且可為 ascdesc 來指定每個欄位的遞增或遞減順序。 預設值為 ,asc

以下是 orderby 字串 範例:orderby=date

注意:任何參數都必須來自 groupby支援的清單。

依群組分類 字串 語句,僅將數據匯總套用至指定的欄位。 您可以指定下欄位:
  • failureName
  • failureHash
  • 符號
  • 操作系統版本
  • 事件類型
  • 市場
  • 裝置類型
  • packageName
  • packageVersion

傳回的數據列將包含 groupby 參數中指定的欄位,以及如下內容:

  • 日期
  • 應用程式ID
  • applicationName
  • 設備數量
  • 事件數量

groupby 參數可以搭配 aggregationLevel 參數使用。 例如:&分組依據=故障名稱,市場&聚合級別=周

注意:參數不能包含重複項目。

요구範例

下列範例示範取得錯誤報告數據的數個要求。 請將 applicationId 的值替換為您的應用程式的商店 ID。

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

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

回應

回應內容

價值 類型 描述
價值 陣列 對象的陣列,其中包含匯總錯誤報告數據。 如需有關每個物件中數據的詳細資訊,請參閱下方 錯誤值 段落。
@nextLink 字串 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求 top 參數設定為 10000,但查詢有 10000 個以上的錯誤數據列,則會傳回這個值。
TotalCount 整數 查詢數據結果中的數據列總數。

錯誤值

Value 陣列中的元素包含下列值。

價值 類型 描述
日期 字串 錯誤資料日期範圍中的第一個日期,格式為 yyyy-mm-dd。 如果要求指定單一天,這個值就是該日期。 如果要求指定較長的日期範圍,這個值就是該日期範圍中的第一個日期。 指定 aggregationLevel小時的請求,此值亦包含格式為 hh:mm:ss的時間值。
applicationId 字串 您想要擷取錯誤資料之應用程式的市集標識碼。
應用程式名稱 字串 應用程式的顯示名稱。
故障名稱 字串 失敗的名稱,由四個部分組成:一或多個問題類別、例外狀況/錯誤檢查程式代碼、發生失敗的映像名稱,以及相關聯的函式名稱。
failureHash 字串 錯誤的唯一標識碼。
象徵 字串 指派給此錯誤的符號。
作業系統版本 字串 下列其中一個字串,指定發生錯誤的作業系統版本:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • 未知
osRelease 字串 下列其中一個字串,指定發生錯誤的作業系統版本或內部測試環(作為作業系統版本內的一個子群體)。

針對 Windows 11:版本 2110

針對 Windows 10:

  • 版本 1507
  • 版本 1511
  • 版本 1607
  • 版本 1703
  • 版本 1709
  • 版本 1803
  • 發行預覽
  • Insider Fast
  • 內部人員緩慢

適用於 Windows Server 1709:

  • RTM

針對 Windows Server 2016:

  • 版本 1607

針對 Windows 8.1:

  • 更新 1

針對 Windows 7:

  • 服務包 1

如果作業系統的版本或測試環未知,此欄位的值為 未知

事件類型 字串 下列其中一個字串:
  • 當機
  • 停止回應
  • 記憶體
  • jse
市場 字串 裝置市場的 ISO 3166 國家/地區代碼。
設備類型 字串 下列其中一個字串,指出發生錯誤的裝置類型:
  • 電腦
  • 電話
  • Console-Xbox One
  • Console-Xbox 系列 X
  • 物聯網
  • 全像攝影
  • 未知
packageName 字串 與此錯誤相關聯的應用程式套件唯一名稱。
packageVersion (套件版本) 字串 與此錯誤相關聯的應用程式套件版本。
deviceCount 數字 與指定匯總層級的此錯誤相對應的唯一裝置數。
事件計數 數字 針對指定的匯總層級,歸因於此錯誤的事件數量。

注意

此方法只能擷取過去 30 天內發生的錯誤。

要求和回應範例

下列代碼段示範一個請求的範例以及該請求的 JSON 回應主體。

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId=9NBLGGGZ5QDR&startDate=07/02/2022&endDate=07/20/2022&top=10&skip=0&filter=market eq 'US'&groupby=failureName,failureHash,symbol,osVersion,eventType,market,deviceType,packageName,packageVersion,osRelease&orderby=date
HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_BlockedOn_FileIO_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_Microsoft.Contoso Demo!unknown_error_in_application",
            "failureHash": "c21da75f-ea4d-538b-cfec-73654ef810b9",
            "symbol": "Microsoft.Contoso Demo!unknown_error_in_application",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "PC",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 6.0,
            "eventCount": 1.05263157894737
        },
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_BlockedOn_FileIO_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_Microsoft.Contoso Demo!unknown_error_in_application",
            "failureHash": "c21da75f-ea4d-538b-cfec-73654ef810b9",
            "symbol": "Microsoft.Contoso Demo!unknown_error_in_application",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "Unknown",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 7.14285714285714,
            "eventCount": 1.05263157894737
        },
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_twinapi.appcore.dll!WaitCoalesced",
            "failureHash": "233e04bb-7a3d-eb28-c316-1120aa9defc0",
            "symbol": "twinapi.appcore.dll!WaitCoalesced",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "PC",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 6.0,
            "eventCount": 8.94736842105263
        }
    ],
    "@nextLink": "failurehits?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2022/07/02&endDate=2022/07/21&top=10&skip=10&groupby=failureName,failureHash,symbol,osVersion,eventType,market,deviceType,packageName,packageVersion,osRelease&filter=market eq 'US'&orderby=date",
    "TotalCount": 443
}