什麼是 API 分析？

發佈 API供外部使用只是 API 生命週期中的一個步驟，想要更深入瞭解 API 對於業務和技術的持續影響，需要強大的 API 分析技術。開發人員若要成功採用 API，就需要監控及管理 API 程式的所有操作方面。

為什麼使用 API 分析？

• 獲得由洞察驅動的結果：對生態系統進行即時資料洞察，像是應用程式、消費、性能和使用指標（峰值、延遲、回應時間），以獲得程式的端對端可見度
• 管理風險：即時營運指標可推動決策制定，並保護 API 程式免受網路攻擊。
• 改善客戶體驗：與客戶（開發人員和 API 消費者）建立更好的關係，並根據資料洞察做出最佳決策（衡量參與度和 API 性能）
• 監控 KPI：追蹤及衡量跨產品、應用程式、頻道和位置的 API 使用情況。

常見問題

回答以下問題將幫助您改進 API 平台、解決問題，並做出更好的業務決策：

• 我的 API 流量表現如何？
• 哪些 API 方法最受歡迎？
• 誰是頂級 API 開發人員？
• 是否存在阻礙回應時間的問題？
• API 流量最多的位置在哪裡？

API 分析的好處

獲得 API 性能的操作可見度

監控 API 使用的趨勢和模式，包括延遲、錯誤率、快取性能、使用模式和呼叫高峰。在各種容易理解的儀表板中查看結果，以進行智慧 API 分析。

瞭解您的 API 如何被使用

一目瞭然地查看誰正在使用您的 API，以及他們如何使用您的 API。API 分析可幫助您瞭解方法層級的使用情況，以發現採用和使用模式的趨勢。

使用 API 呼叫追蹤技術進行故障排除

遇到 API 錯誤問題？使用我們的即時呼叫追蹤功能即可深入瞭解 API 呼叫流程，幫助識別問題區域和故障點。

匯出呼叫日誌資料以供外部使用

您可隨心所欲使用，將全部 API 呼叫日誌資料匯出到 TIBCO Spotfire （或您選擇的客製化 API 分析環境），並將日誌資料推送到計費軟體以透過 API 獲利。

獲取對儀表板和報告資料的 API 存取權限

透過 API 報告工具來存取開箱即用的儀表板和報告，即可使用其中顯示的任何資料進行程式化匯出和重複使用。

API 分析報告的類型

高階：執行摘要

執行摘要頁面以容易分享的格式，為整個組織的高階主管級利益相關者受眾提供應用程式介面 (API) 軟體的高階視圖，其中納入了新的分析指標和趨勢。

執行摘要旨在快速有效地提供一套全方位洞察資訊，無需進行任何資料收集和分析任務。執行摘要是對管理儀表板上現有報告的補充，專為 API 管理員、API 產品經理、業務開發主管、行銷主管和技術高階主管等廣泛受眾而設計。

中階：報告

報告會將資料視覺化，以幫助監控 API、封包、計畫、端點和開發人員的技術性能與業務指標。

使用者存取報告後可以：

• 查看 API 使用摘要
• 查看 API 技術性能資料
• 查看開發者活動
• 查看和分析 API 呼叫延遲
• 查看和分析錯誤回應

低階：呼叫日誌匯出、呼叫日誌串流、呼叫檢查器

呼叫日誌匯出

呼叫日誌匯出功能允許您存取和篩選原始 API 呼叫日誌，並將它們匯出為 CSV 檔案。新日誌每 30 分鐘交付一次，其中包含詳細的 API 呼叫資訊，例如來源 IP 地址、URI、服務名稱和端點名稱。此資料有許多可能的使用案例，包括精細計費、濫用檢測、故障排除等。

呼叫日誌串流

呼叫日誌串流主頁面會顯示一份導覽清單，列出所有的呼叫日誌串流頻道記錄，您可以從中存取以下資訊：

• 頻道名稱：呼叫日誌串流的頻道名稱；預設名稱為「Channel for（區域名稱）」
• 狀態：通道的狀態，為啟用或停用
• 建立：頻道建立的日期和時間
• 更新：頻道上次更新的日期和時間

呼叫檢查器

Call Inspector（呼叫檢查器）是一項診斷功能，用於在 API 呼叫通過系統時對其進行追蹤，能提供有關請求和回應在通過不同點時的實際狀態詳細資訊。客戶可以使用 Call Inspector 來解決 API 呼叫失敗或支援新整合等使用案例。藉由啟用指定端點和時段的呼叫日誌，即可擷取出 API 呼叫資料。

API 分析指標

每個團隊都希望追蹤不同的指標，基礎架構團隊的 API 指標將不同於產品團隊的 API 指標。API 指標還取決於 API 產品生命週期。例如，新的 API 將更多地專注於改進設計和使用，而舊的 API 可能會專注於附加功能。

有四個主要群組會依賴 API 指標：

DevOps

DevOps 團隊用來確保伺服器正常運作，並正確分配有限的資源，這可能適用於多個工程團隊。

有幾個指標對這個團隊很重要：

• 正常運作時間
• CPU 使用率
• 記憶體使用情況

應用程式工程

API 開發人員在解決 API 業務邏輯問題的同時，也會向 API 增加新功能。他們會開發外掛程式、合作夥伴整合、納入其他 API 等產品。

對這個團隊很重要的三個指標包括：

• 每分鐘請求 (RPM)
• 平均和最大延遲
• 每分鐘錯誤

產品管理

API 產品經理設計 API 功能是為了確保構建正確的端點，並在客戶需求和時間限制之間取得平衡。

對這個團隊很重要的一些指標包括：

• API 使用量增長
• 個別 API 客戶
• API 使用量最高的客戶
• API 保留
• 第一個 Hello World 時間 (TTFHW)
• 每個業務交易的 API 呼叫
• SDK 和版本採用

業務成長

行銷和銷售等面向業務的團隊通常不會考慮 API 端點，他們對客戶採用率、以及查看哪些使用者可能成為新的銷售機會更感興趣。

對這個團隊很重要的三個指標包括：

• 收入
• 採用率
• 客戶成功