Skip to content

WebSite - API Info

📘 功能概述

當發現某個 Domain 整體錯誤率偏高時,可以使用「API Info」頁面進行更細緻的問題排查。此頁面專注於分析該 Domain 下各個靜態資源或 API 的使用情況,包括錯誤發生頻率、回應速度與內容大小等,協助快速定位異常原因。

支援:

  • 錯誤類型檢視(根據 HTTP Code)
  • 例外狀況記錄(如 5xx)

讓開發者快速找出問題 API 並即時處理。

API Info

🧭 功能說明

1. 篩選區

  • CountryDomain 下拉選單:
    • 可選擇特定國家與 Domain,精確聚焦分析對象。
    • 範圍縮小後有助於觀察錯誤是否集中於某一地區或網域。

2. 狀態總覽 (右上資訊列)

  • Total Success Request:成功請求次數
  • Total Fail Request:失敗請求次數
  • AVG Response Time:平均回應時間(毫秒)
  • AVG Failure Rate:平均錯誤率(百分比)

3. Project Failure Rate 趨勢圖

  • 顯示指定 Domain 在當天各時段的錯誤率變化情形。
  • 可選取特定時間點進行深入檢查。
  • 點擊圖中節點,會同步顯示下方該時間點的 API 詳細資料表。

📊 API 使用資訊表格 (Data Table)

當選定某個時間點後,表格會列出該時間內的所有 API 使用紀錄,包含下列欄位:

欄位名稱說明
API Url被呼叫的 API 或靜態資源 URL
Fail Rate該 API 的失敗率 (Fail / (Fail + Success))
Success成功請求次數
Fail失敗請求次數
Error Code錯誤狀態碼(例如 5xx)
Error Message對應的錯誤訊息(如 Network Error)
ms TimeAPI 的平均回應時間(毫秒)
Size(Byte)平均傳輸大小(Bytes)

🔍 使用方式分析

  1. 問題偵測

    • 當發現某個 Domain 的錯誤率持續偏高,可透過此頁篩選出該 Domain 與地區,判斷問題是否集中於某地區的用戶。
  2. 時間點分析

    • 透過趨勢圖挑選異常高點,可進一步查看該時段是否有單一 API 錯誤率過高。
  3. 錯誤判斷

    • 透過 Error Code、Message 快速辨識問題類型(網路錯誤、資源不存在、回應逾時等),同時也可點擊該 URL開啟 API 測試畫面,對此API使用該主機進行測試。
  1. 效能分析
    • 若 Response Time 偏高或 Size 過大,可能造成用戶等待過久。此頁提供數據依據判斷效能瓶頸是否來自 API 設計或靜態資源過重。

💡 適用情境

  • Debug 某個高錯誤率的時間區段
  • 分析大型靜態資源的效能對使用者體驗的影響
  • 比對多個 API 的表現差異
  • 排查區域性 API 可用性問題(如某國家使用者回應變慢)