在 Microsoft 市集分析 API 中使用此方法,以 JSON 格式取得您應用程式的匯總錯誤報告數據,以指定日期範圍和其他選擇性篩選。 此方法只能擷取過去 30 天內發生的錯誤。 此資訊也可以在合作夥伴中心的健康情況報告的失敗區段中取得。
您可以使用 取得錯誤詳細數據、 取得堆疊追蹤,以及 下載 CAB 檔案 方法來擷取其他錯誤資訊。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未完成,請完成 Microsoft 市集分析 API 的所有必要條件。
- 取得 Azure AD 存取令牌 ,以用於此方法的要求標頭中。 取得存取令牌後,您有 60 分鐘的時間在到期之前使用它。 令牌到期之後,您可以取得新的令牌。
請求
要求語法
| 方法 | 要求 URI |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits |
請求標頭
| 頁眉 | 類型 | 描述 |
|---|---|---|
| 授權 | 字串 | 必填。 Azure AD 存取令牌的形式為 Bearer<token>。 |
要求參數
| 參數 | 類型 | 描述 | 必填 |
|---|---|---|---|
| 應用程式ID | 字串 | 您想要擷取錯誤報告數據之應用程式的市集標識碼。 市集標識碼可在合作夥伴中心的 [應用程式身分識別] 頁面上 取得。 市集標識符範例為 9WZDNCRFJ3Q8。 | 是的 |
| 開始日期 | 日期 | 要擷取的錯誤報告數據日期範圍的起始日期。 預設值為目前的日期。 如果 aggregationLevel 是 day、 week 或 month,此參數應該以 格式 mm/dd/yyyy指定日期。 如果 aggregationLevel 為 hour,這個參數就可以以 格式 mm/dd/yyyy 指定日期,或 格式 yyyy-mm-dd hh:mm:ss的日期和時間。
注意: 此方法只能擷取過去 30 天內發生的錯誤。 |
不 |
| 結束日期 | 日期 | 要擷取之錯誤報告數據的日期範圍結束日期。 預設值為目前的日期。 如果 aggregationLevel 是 day、 week 或 month,此參數應該以 格式 mm/dd/yyyy指定日期。 如果 aggregationLevel 為 hour,這個參數就可以以 格式 mm/dd/yyyy 指定日期,或 格式 yyyy-mm-dd hh:mm:ss的日期和時間。 |
不 |
| 返回頁首 | 整數 | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多數據列,響應主體會包含下一個連結,您可以用來要求下一頁的數據。 | 不 |
| 略過 | 整數 | 查詢中要略過的行數。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 不 |
| 過濾器 | 字串 | 篩選回應中數據列的一或多個語句。 每個敘述都包含回應本文的欄位名稱,以及與 eq 或 ne 運算符相關聯的值,而且敘述可以使用 和或結合。 字串值必須以 篩選 參數中的單引弧括住。 您可以從回應正文指定下列欄位:
|
不 |
| 聚合層級 | 字串 | 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串: 小時、 日、 周或 月。 如果未指定,則預設值為 day。 如果您指定 week 或 month,則 failureName 和 failureHash 值會限制為 1000 個桶。 注意: 如果您指定 小時,則只能從前 72 小時擷取錯誤數據。 若要擷取超過 72 小時的錯誤數據,請指定 日期 或其中一個其他匯總層級。 | 不 |
| 排序 | 字串 | 排序結果數據值的語句。 語法為 *orderby=field [order]。
field 參數可以是下列字串的一個(且只有一個):
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設值為 asc。 以下是 orderby 字串 注意:任何參數都必須來自 groupby 支援的清單。 |
不 |
| 依群組分類 | 字串 | 語句,僅將數據匯總套用至指定的欄位。 您可以指定下欄位:
傳回的資料列將包含 groupby 參數中指定的欄位,以及下列內容:
groupby 參數可以搭配 aggregationLevel 參數使用。 例如: &groupby=failureName,market&aggregationLevel=week 注意:參數不能包含重複項目。 |
不 |
요구範例
下列範例示範取得錯誤報告數據的數個要求。 以您應用程式的市集標識碼取代 applicationId 值。
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 個以上的錯誤數據列,則會傳回此值。 |
| 總計數 | 整數 | 查詢數據結果中的數據列總數。 |
錯誤值
Value 陣列中的元素包含下列值。
| 價值 | 類型 | 描述 |
|---|---|---|
| 日期 | 字串 | 錯誤資料日期範圍中的第一個日期,格式為 yyyy-mm-dd。 如果要求指定單一天,這個值就是該日期。 如果要求指定較長的日期範圍,這個值就是該日期範圍中的第一個日期。 針對指定 aggregationLevel 值為 hour 的要求,該值也包含以格式的時間值。 |
| 應用程式ID | 字串 | 您想要擷取錯誤資料之應用程式的市集標識碼。 |
| 應用程式名稱 | 字串 | 應用程式的顯示名稱。 |
| 故障名稱 | 字串 | 失敗的名稱,由四個部分組成:一或多個問題類別、例外狀況/錯誤檢查程式代碼、發生失敗的映像名稱,以及相關聯的函式名稱。 |
| 失敗哈希 | 字串 | 錯誤的唯一標識碼。 |
| 象徵 | 字串 | 指派給此錯誤的符號。 |
| 作業系統版本 | 字串 | 下列其中一個字串,指定發生錯誤的作業系統版本:
|
| osRelease作系統 | 字串 | 下列其中一個字串,指定發生錯誤的作業系統版本或內部測試環(作為作業系統版本內的一個子群體)。 針對 Windows 11: 版本 2110 針對 Windows 10:
適用於 Windows Server 1709:
針對 Windows Server 2016:
針對 Windows 8.1:
針對 Windows 7:
如果 OS 版本或測試通道未知,則此欄位的值為 Unknown。 |
| 事件類型 | 字串 | 下列其中一個字串:
|
| 市場 | 字串 | 裝置市場的 ISO 3166 國家/地區代碼。 |
| 設備類型 | 字串 | 下列其中一個字串,指出發生錯誤的裝置類型:
|
| packageName (包名稱) | 字串 | 與此錯誤相關聯的應用程式套件唯一名稱。 |
| packageVersion (套件版本) | 字串 | 與此錯誤相關聯的應用程式套件版本。 |
| 裝置數量 | 數字 | 與指定匯總層級的此錯誤相對應的唯一裝置數。 |
| 事件計數 | 數字 | 針對指定的匯總層級,歸因於此錯誤的事件數量。 |
注意
此方法只能擷取過去 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
}