選單路徑: 儀表板 > 日誌

日誌

概述

日誌是您可以在同一處檢視某個端點所有 API 呼叫記錄的頁面。您可以查看請求的成功/失敗、傳送的 Payload、Webhook 傳遞狀態以及錯誤訊息。

沙箱環境和正式環境分別位於不同的分頁中,因此您可以獨立追蹤測試呼叫和實際營運呼叫。

如何進入

  • 頂部選單 日誌 → 從清單中選擇一個端點
  • 端點詳情右側邊欄中的 檢視日誌 連結

端點清單

日誌端點清單

首次開啟日誌頁面時,您會看到端點清單。它依端點彙總了日誌狀態。

欄位 說明
端點 端點名稱
總日誌數 此端點的總呼叫次數
成功率 成功呼叫所佔的百分比
最近活動 最近一次呼叫時間(相對時間)

點擊某個端點即可進入其詳細日誌頁面

詳細頁面頂部

詳細頁面頂部

選擇某個端點後,頁面頂部會顯示以下元素。

  • 端點名稱和說明
  • 檢視 API 詳情 按鈕 — 前往端點詳情頁面
  • 清除沙箱資料 按鈕 — 永久刪除此端點的沙箱呼叫記錄和使用統計
    • 協作者存取時顯示為 清除我的沙箱資料,僅刪除該協作者產生的記錄
    • 不會影響正式環境資料
  • 沙箱環境 | 正式環境 環境分頁 — 獨立檢視各環境的日誌(詳細了解環境分頁

搜尋篩選

搜尋區域包含兩個分頁:時間段搜尋欄位搜尋

時間段搜尋

時間段搜尋篩選

依時間範圍和狀態篩選日誌。

  • 日期欄位 — 選擇 處理時間建立時間。預設為處理時間
  • 開始日期 / 結束日期 — 指定時間範圍
  • 狀態 — 可選擇 全部 / 成功 / 失敗
  • 協作金鑰全部 或特定的協作金鑰(僅顯示使用該金鑰發起的呼叫)

欄位搜尋

欄位搜尋篩選

當您希望依特定值查詢日誌時使用。

  • 欄位 選擇:
    • 請求 ID — 依記錄 ID 精確比對
    • 內容搜尋 — 在端點的可搜尋欄位中搜尋值(例如 order_idcustomer_email,至少 3 個字元)
  • 輸入 搜尋值 並執行
  • 選擇 內容搜尋 時會出現 開始日期 / 結束日期 輸入框。若未指定日期,預設在最近一個月內搜尋

日誌清單

日誌清單

搜尋篩選下方以表格形式顯示該端點的呼叫歷史。

欄位 說明
請求 ID 記錄識別碼
狀態 成功 · 失敗 · 處理中 徽章
協作金鑰 本次呼叫使用的協作金鑰(未指定則為預設)
建立時間 API 呼叫接收時間
處理時間 儲存和 Webhook 處理完成時間

點擊任一列即可進入日誌詳情頁面


日誌詳情頁面

概覽

日誌概覽

顯示單次呼叫的詳細資訊。

  • 請求 ID:記錄的唯一識別碼
  • 端點:接收此次呼叫的端點
  • 版本:呼叫時的設定版本
  • 處理時間:儲存和 Webhook 處理完成時間
  • 回應時間:閘道處理時間(毫秒)
  • 協作金鑰:所使用協作金鑰的名稱和描述(如適用)
  • 錯誤訊息 / 錯誤詳情:對於失敗的呼叫,顯示錯誤類型、狀態碼、欄位錯誤和發生時間
  • 檢視端點 按鈕 — 前往此端點的詳情頁面

Payload

Payload 區塊

顯示隨 API 呼叫傳送的原始 JSON 資料

在正式環境中,超過 30 天的 Payload 會被自動封存,不會直接顯示在清單中。此時請點擊 載入封存 Payload 按鈕以取得已封存的 Payload。

Danger Zone

Danger Zone

  • 刪除日誌記錄 — 永久刪除此日誌記錄
  • 記錄本體及其關聯的 Payload 會一併刪除。此操作無法復原
  • 不會影響使用統計

檢視端點快速連結

詳細頁面右側顯示一張快速連結卡片,可跳轉至目前日誌對應的端點詳情頁面。您可以快速確認端點的設定、Webhook、協作金鑰等。


常見問題

  • 日誌為空:在正式部署之前,正式環境分頁不會顯示任何記錄。請先在沙箱環境分頁確認測試呼叫是否已被記錄
  • 搜尋無結果內容搜尋 要求端點已定義可搜尋欄位(Searchable)。請在端點詳情 > 必填欄位中確認 Searchable 是否已設定
  • 看不到 Payload:在正式環境中,超過 30 天的呼叫的 Payload 會被封存。請使用 載入封存 Payload 按鈕取得
  • 想僅檢視某位協作者的呼叫:在時間段搜尋分頁的 協作金鑰 下拉選單中選擇該協作金鑰
  • 沙箱清除可以復原嗎?:不可以。被清除的沙箱呼叫記錄和統計會被永久刪除,請謹慎使用