跳至主要内容

Audit Logs API

列出稽核日誌

GET /v1/audit/logs

GET /v1/audit/logs?start_time=2026-05-01T00:00:00Z&end_time=2026-05-31T23:59:59Z
Authorization: Bearer sk-your-api-key

查詢參數:

參數類型必填說明
start_timestring開始時間(ISO 8601)
end_timestring結束時間(ISO 8601)
actionstring篩選操作類型(例如 gateway.chat
pagenumber頁碼,預設 1
page_sizenumber每頁筆數,預設 20,最大 100

回應:

{
"success": true,
"data": {
"items": [
{
"id": "audit-uuid",
"action": "gateway.chat",
"model": "openai/gpt-4o",
"created_at": "2026-05-08T12:00:00Z",
"credits_consumed": 0.05,
"balance_consumed_usd": 0.000240,
"metadata": {
"user_id": "user-123"
}
}
],
"pagination": {
"page": 1,
"per_page": 20,
"total_items": 450,
"total_pages": 23
}
}
}

取得稽核日誌詳情

GET /v1/audit/logs/{id}

GET /v1/audit/logs/audit-uuid
Authorization: Bearer sk-your-api-key

回應包含更完整的資訊:

{
"success": true,
"data": {
"id": "audit-uuid",
"action": "gateway.chat",
"model": "openai/gpt-4o",
"created_at": "2026-05-08T12:00:00Z",
"usage": {
"prompt_tokens": 1200,
"completion_tokens": 350,
"total_tokens": 1550
},
"rag_query": "退款政策是什麼",
"rag_sources_count": 3,
"memory_used": true,
"credits_consumed": 0.05,
"balance_consumed_usd": 0.000240,
"metadata": {
"user_id": "user-123",
"ticket_id": "ticket-456"
}
}
}

詳情回應的額外欄位:

欄位類型說明
usageobjectToken 用量(僅 Gateway 操作)
rag_querystringRAG 查詢文字(若啟用 RAG)
rag_sources_countnumber引用的 RAG 段落數
memory_usedboolean是否有注入 Memory

匯出稽核日誌

POST /v1/audit/logs/export

POST /v1/audit/logs/export
Authorization: Bearer sk-your-api-key
Content-Type: application/json
{
"format": "csv",
"start_time": "2026-05-01T00:00:00Z",
"end_time": "2026-05-31T23:59:59Z",
"action": "gateway.chat"
}

請求欄位:

欄位類型必填說明
formatstringcsvjson
start_timestring開始時間(ISO 8601)
end_timestring結束時間(ISO 8601)
actionstring只匯出特定操作類型

回應:

{
"success": true,
"data": {
"export_id": "export-uuid",
"status": "processing",
"estimated_rows": 4500
}
}

匯出任務非同步執行,完成後可透過 export_id 查詢狀態和下載連結。


所需權限

操作所需權限
讀取稽核日誌audit.read
匯出稽核日誌audit.export(Pro+ 方案)