メール送信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 |
YYYY-MM-DD hh:mm:ss の形式であること |
集計の起点となる日時 |
| from | 数値 | 1 | 1以上の整数 | 取得を開始する行番号 |
| to | 数値 | 1 |
fromより大きい整数 |
取得を終了する行番号 |
| batch_id | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した batch_id |
| label1 | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した custom_args の label1 要素の値 |
| label2 | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した custom_args の label2 要素の値 |
| label3 | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した custom_args の label3 要素の値 |
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| jsonリクエストのバリデーションエラー | 400 |
| 認証失敗 | 401 |
| 実行中の同種別ジョブが多すぎる | 403 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| job_id | 数値 | 1 | ジョブID |