機能説明
メール送信APIが受信したリクエストによって送信されたメールごとに、最新のイベントのサマリを一覧で返します。
起点となる日時から遡り、指定された行番号の数だけイベントのサマリを取得します。
起点となる日時は、未来の日は指定できませんが、未来の時間は指定することができます。
抽出のために使用するlabel1、label2、label3は、メール送信APIのcustom_args項目内でlabel1、label2、label3の値に文字列を指定してください。
labelの値が64文字を超過する、もしくは半角英数字記号以外の文字を含む場合は除外されます。
メール送信APIのtrackingに含まれるlabel1、label2、label3とは別であることに注意してください。
イベントサマリは、通常過去7日分を保存しています。
ジョブは非同期で実行され、レスポンスに含まれるジョブIDで結果を取得することができます。
リクエスト
エンドポイント
/v2/events/summaries
HTTPメソッド
POST
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| start_at | 文字列 | 1 |
|
集計の起点となる日時
この日時より過去の結果が集計されます。 |
| from | 数値 | 1 |
|
取得を開始する行番号 |
| to | 数値 | 1 |
|
取得を終了する行番号 |
| 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":{"start_at": "unit is invalid"}}