occurred_after に畳み込みます(12 か月前の同じ日の UTC 午前 0 時を起点とし、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 で確認できます。
グレイン
レポーティング用シミュレーションイベントごとに 1 行です。同じメッセージを開封し、その後クリックした人は 2 行になります。entity_id が null のイベント(アクター/受信者/対象参加者なし)も表示されます。この場合、email は null です。
API のウィンドウは 1 分間広げられます。正確な occurred_at >= WindowStart の境界はローカルで再適用されるため、直近 1 年間は、サーバーが occurred_after を包含的に扱うか排他的に扱うかに依存しません。
リクエスト予算:ウィンドウ内のイベントのページネーション付き走査 1 回と、エンティティの走査 1 回です。必ず 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がありますが、エミッターは自由形式の文字列を保存するため、固定の列挙型ではなくオープンテキストとして扱ってください。イベントに派生クラスがない場合は null となり、生のuser_agent文字列は非公開のままです。 - 「Email Sent」は
simulation.deliveredです。 送信をフィルターまたは集計する際は、このトークンを使用してください。従来のemail_sent文字列を探さないでください。 - 受信者のメールアドレスは、イベントのフィールドではなく結合で取得します。 レポーティングイベントにはメールアドレスが含まれないため、クエリは
/entitiesをたどって補完します。 - 直近 12 暦月であり、365 日間の期間でも全履歴でもありません。
- ロングフォームであり、集約されません。 1 人につき 1 つの結果ではなく、やり取りごとに 1 行です。
次のステップ
Power BI と Excel のセットアップ
認証情報、ページネーション、および Power BI や Excel でのこれらのクエリの読み込み。
最も影響を受けやすいユーザー
個人単位の 12 か月間のクリック、認証情報、報告の集計。
個人別コンプライアンス
個人 × 割り当て単位のトレーニング登録。
API キー
このレポートを更新するキーに
reporting:read と entity:read を付与します。
