occurred_after(即十二個月前同一日期的 UTC 午夜,而非 365 天的時間長度)。
原始用戶端 IP 絕不會出現在
/v1 上,這是基於隱私的設計,並非尚待完成的對應。裝置類型是事件列上的衍生類別;原始 user_agent 仍保持私有。請參閱與舊版匯出的差異。Fn_FetchAll 查詢;本報表會依名稱呼叫該查詢。
必要的金鑰範圍
僅被授予
simulation:read 的金鑰無法呼叫報表事件端點(API 會傳回 403)。請參閱選擇正確的粒度。
來源端點
事件清單上允許的篩選條件(其他任何條件都會傳回
400):
limit、page_token、simulation、entity、event_type、
occurred_after。
此報表系列屬於預覽資料集。
請於 GET /v1/reporting/datasets 與
GET /v1/reporting/datasets/simulation_events 檢視資料集結構描述與資料政策。
粒度
每個報表模擬事件對應一列。若某人開啟後又點擊同一封郵件,則會產生兩列。entity_id 為空值的事件(無執行者/收件者/目標參與者)仍會顯示,此時 email 為空值。
API 時間範圍會擴大一分鐘;occurred_at >= WindowStart 的確切界限會在本機重新套用,因此過去一年的範圍不會取決於伺服器將 occurred_after 視為包含或排除。
請求預算:對時間範圍內的事件進行一次分頁走訪,再加上對實體進行一次走訪。請務必設定 limit = "500"。
欄位對應
舊版欄位名稱來自您先前供應商的匯出檔。/v1 欄位為公開 API 名稱;查詢會為報表將其中部分欄位設定別名。
動作代碼
action 是封閉式的報表代碼。舊版的「Email Sent」對應至 simulation.delivered(delivered 是公開動詞;傳輸代碼為 simulation.delivered)。
因 API 提供而額外保留的欄位:
sender_domain、full_name、event_id、entity_id、simulation_id、occurred_at,以及來自實體聯結的 entity_type 與 entity_status。
與舊版匯出的差異
- 無法取得原始 IP。
/v1不會公開原始用戶端 IP,這是基於隱私的設計,並非尚待完成的對應。查詢不會新增預留位置 IP 欄位。 - 裝置類型為衍生值,而非原始值。
device_type是針對點擊、提交與回報事件的衍生裝置類別。觀察到的代碼包括desktop、mobile、tablet與unknown,但發送端儲存的是自由格式字串,請將其視為開放文字,而非封閉列舉。事件沒有衍生類別時為空值,原始user_agent字串仍保持私有。 - 「Email Sent」為
simulation.delivered。 篩選或計算寄送次數時,請使用該代碼。請勿尋找舊版的email_sent字串。 - 收件者電子郵件是聯結取得,而非事件上的欄位。 報表事件不含電子郵件;查詢會走訪
/entities來填入。 - 過去 12 個日曆月,而非 365 天的時間長度,也不是完整歷程。
- 長格式,不彙整。 每次互動一列,而非每人一個結果。
後續步驟
Power BI 與 Excel 設定
認證、分頁,以及在 Power BI 或 Excel 中載入這些查詢。
最易受害使用者
以個人為單位的 12 個月點擊、認證與回報彙總。
個人合規性
以人員 × 指派為粒度的訓練註冊。
API 金鑰
在用於重新整理此報表的金鑰上授予
reporting:read 與 entity:read。
