API 使用情況歷史報告
API 使用歷史報告有助經理和管理員了解特定時段的 API 使用情況。高層次的使用趨勢與詳細的終點資料結合,讓您可以追蹤模式、調查意外變更,並為容納人數作計劃。使用本報告可:
-
在用戶端應用程式層面監察頻繁的API呼叫。
-
深入了解特定端點,以了解使用模式。
-
了解API使用逐日或特定時段的更改情況。
Analytics 指標趨勢報告是根據兩個小工具的數據為基礎。
-
API 使用摘要小工具
-
API 使用詳情小工具
Clarissa Dalloway 負責管理與多個依賴資料提取 API 的內部系統的整合。她負責確保這些整合保持穩定、安全及可預測。她希望瞭解不同的客戶端應用程式及端點在特定時段內如何使用資料提取 API,以便監察使用量、調查異常模式,並為未來的增長進行計劃。
Clarissa 開啟 API 使用歷史報告。她查看 API 使用摘要小工具,以檢視過去 30 天內各客戶端應用程式的 API 調用量。她留意是否有與預期發佈、設定變更或新整合上線相符的增加或減少情況。這有助她確認使用量是否在預期範圍內,或者是否有突然的激增可能導致效能或容納人數方面的問題。
Clarissa 注意到 API 調用量有所上升,而這與任何預期事件均不相符。接下來,她使用「API 使用詳情」小工具,查看該上升發生當天的調用次數、端點、回覆代碼及客戶端應用程式 ID。
Clarissa發現其中一個客戶端應用程式顯示某個終點的呼叫次數急增。她使用API Usage Detail小工具中的詳細列,查看哪些方法、路徑及小時導致此次激增,並匯出資料作進一步分析,然後與其開發團隊分享,以便他們調整其整合並管理未來的API使用情況。
API 使用摘要小工具
API 使用摘要小工具提供所選時間框架內按客戶端應用程式劃分的 API 調用量每日摘要。
對於此小工具,您可以:
-
檢視一個或多個客戶端應用程式隨特定時段的 API 調用數量摘要。
-
驗證 API 消耗模式是否符合預期的整合行為。
此小工具的設定如下:
-
預設日期範圍:過去30天
-
最大日期範圍:95天視窗
-
Metrics selector: 無
此小工具的其他篩選器包括:
-
無
下表描述此小工具中的欄:
|
欄名稱 |
描述 |
|---|---|
|
日期 |
API 呼叫發生時的日曆日期。 |
|
應用程式 ID |
進行 API 調用的客戶端應用程式的唯一識別碼。 |
|
應用程式名稱(客戶端) |
進行 API 調用的客戶端應用程式的顯示名稱。 |
|
API 電話次數 |
總計客戶端應用程式在指定日期所進行的API呼叫數目。 |
API 使用詳細資料小工具
API 使用詳情小工具就每個客戶端應用程式、日期、時、HTTP 方法及終點的 API 使用情況提供詳細的深入分析。
對於此小工具,您可以:
-
針對特定客戶端應用程式或方式進行分析,以了解其詳細使用模式。
-
匯出資料至CSV或Excel,以作進一步分析或與其他團隊分享。
此小工具的設定如下:
-
預設日期範圍:今天
-
最大日期範圍:95天視窗
-
Metrics selector:無
此小工具的其他篩選器包括:
-
方法
下表描述此小工具中的欄:
|
欄名稱 |
描述 |
|---|---|
|
日期 |
API 使用情況的日曆日期。 |
|
小時 |
時間戳記,表示 API 使用的時間。 |
|
Client 應用程式 ID |
發起 API 調用的客戶端應用程式的唯一識別碼。 |
|
Client 應用程式名稱 |
與 API 使用相關的客戶端應用程式的顯示名稱。 |
|
方法 |
HTTP 方法,用於 API 請求。 |
|
API 路徑 |
所呼叫 API 終點的路徑。 |
|
Return 代碼 |
HTTP 來自 API 回應的返回代碼。 |
|
調用計數 |
在指定日期、時、客戶端應用程式、方法及返回代碼下,終點被調用的次數。 |