機能説明
メール送信APIで受信したリクエストによってメールが外部MTAサーバに到達するまでに発生したイベントの数を集計した結果を返します。
起点となる日時から遡り、指定された単位時間(分・時間・日)で、イベントの種類ごとに発生した数を集計します。
起点となる日時は未来の日は指定できませんが、未来の時間は指定することができます。
抽出のために使用するlabel1、label2、label3は、メール送信APIのcustom_args項目内でlabel1、label2、label3の値に文字列を指定してください。
labelの値が64文字を超過する、もしくは半角英数字記号以外の文字を含む場合は除外されます。
メール送信APIのtrackingに含まれるlabel1、label2、label3とは別であることに注意してください。
イベント集計は、通常過去7日分を保存しています。
ジョブは非同期で実行され、レスポンスに含まれるジョブIDで結果を取得することができます。
リクエスト
エンドポイント
/v2/events
HTTPメソッド
POST
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| start_at | 文字列 | 1 |
|
集計の起点となる日時
この日時より過去の結果が集計されます。 |
| unit | 文字列 | 1 |
下記のいずれか
|
集計する単位時間
day = 1日 hour = 1時間 minute = 1分 |
| range | 数値 | 1 |
|
集計する単位時間
unitがdayの場合 1-7 unitがhourの場合 1-24 unitがminuteの場合 1-1440 |
| mid | 文字列 | 0:1 |
|
メールID |
| batch_id | 文字列 | 0:1 |
|
メールAPIで設定したbatch_id |
| label1 | 文字列 | 0:1 |
|
メールAPIで設定したcustom_argsのlabel1要素の値 |
| label2 | 文字列 | 0:1 |
|
メールAPIで設定したcustom_argsのlabel2要素の値 |
| label3 | 文字列 | 0:1 |
|
メールAPIで設定したcustom_argsのlabel3要素の値 |
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| jsonリクエストのバリデーションエラー | 400 |
| 認証失敗 | 401 |
| 実行中の同種別ジョブが多すぎる | 403 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| job_id | 数値 | 1 | ジョブID |
成功
{"code":200, "job_id":10}
失敗
{"code":400, "validation_errors":{"range":"must be 24 hours or less. current 25"}}