api_request_completed事件模式

合約證據路徑

api_request_completed：從擁有邊界到可信查詢

將 api_request_completed 視為持久的分析合約：所有者發出一個記錄的穀物，一個固定裝置證明欄位，並且經過審查的查詢回答所述問題。

1
結果成為最終結果
HTTP middleware at request completion emits only after the final response status and latency are known.
2
合約是有約束力的
9 required fields preserve the declared grain: One completed API request.
3
夾具已驗證
檢查型別、UTC 時間、替代結果、冪等性以及每個假名或評論分類欄位。
4
問題得到解答
錯誤和緩慢的請求會對客戶產生哪些影響？

穀物

一個已完成的 API 請求。

業主

請求完成時的 HTTP 中介軟體

何時發出

在得知最終回應狀態和延遲後。

現場合約

具有明確隱私邊界的型別化欄位

在生產查詢依賴現有欄位名稱和型別後，保持現有欄位名稱和型別穩定。可選上下文應受到特定決策的限制、記錄和證明。

欄位	型別	必填	隱私	含義
timestamp_utc	timestamp	yes	non-sensitive	結果邊界處的 UTC 時間。
event_id	string	yes	non-sensitive	用於重複資料刪除的穩定唯一識別符號。
release	string	yes	non-sensitive	發出事件的應用程式或服務版本。
account_id	string	yes	pseudonymous	穩定的內部帳戶識別符號，絕不是電子郵件或姓名。
request_id	string	yes	pseudonymous	相關識別符號；不要暴露授權材料。
route	string	yes	non-sensitive	低基數路由範本，例如 /v1/query/:id。
method	string	yes	non-sensitive	HTTP 方法。
status_code	number	yes	non-sensitive	最終 HTTP 回應狀態。
latency_ms	number	yes	non-sensitive	端到端持續時間（以毫秒為單位）。
error_type	string	no	non-sensitive	有界故障類別；省略堆疊追蹤和有效負載。

合成 JSON 事件

{
  "timestamp_utc": "2026-07-28T14:15:06Z",
  "event_id": "evt_api_01",
  "account_id": "acct_8f31",
  "release": "2026.07.2",
  "request_id": "req_2f71",
  "route": "/v1/query/:id",
  "method": "POST",
  "status_code": 200,
  "latency_ms": 184
}

隱私審查

攝取前檢查識別符號

此範例使用合成識別符號。假名值仍然可以是個人資料，並且審查欄位可以公開業務或提供商上下文。應用您自己的同意、保留、存取、居住和刪除要求。

account_id: pseudonymous
request_id: pseudonymous

驗證清單

在建置儀表板之前證明合約

Send one known api_request_completed fixture after the documented outcome boundary.
Verify all 9 required fields arrive with the documented types.
重試相同的事件識別符號並確認所選的重複資料刪除行為。
當工作流程支援時，傳送受控失敗或替代結果。
在固定視窗上執行相關 SQL 並將結果與固定裝置進行協調。

常見錯誤

保持一行等於一個持久結果

Emitting api_request_completed before http middleware at request completion knows the final outcome.
在一張資料表中混合多種穀物，這使得計數和比率不明確。
用原始 URL、有效負載、提示或錯誤文字替換受控類別。
儲存查詢和儀表板依賴於它後就地更改欄位型別。
新增識別符號，無需記錄調查、存取和保留需求。

使用合約