トラッキング設定が有効な配信のトラッキングの結果を集計して取得する。
起点となる日時からさかのぼって、指定された単位時間(分・時間・日)ごと、クリック及び開封ごとに発生した数を集計する。
起点となる日時は、未来の日は指定できないが未来の時間は指定可能。
トラッキング集計情報は通常過去7日分保存される。
ジョブは非同期で実行され、レスポンスに含まれるジョブIDで結果を取得することができる。
リクエスト
エンドポイント
/v2/trackings
HTTPメソッド
POST
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| start_at | 文字列 | 1 |
YYYY-MM-DD hh:mm:ss の形式であること |
集計の起点となる日時 |
| unit | 文字列 | 1 | day hour minute のいずれか |
集計する単位時間 |
| range | 数値 | 1 | 1-1440 の範囲 |
集計する単位時間 |
| mid | 文字列 | 0:1 | 半角英数字 64文字以内 | メールID |
| batch_id | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した batch_id |
| label1 | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した tracking の label1 要素の値 |
| label2 | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した tracking の label2 要素の値 |
| label3 | 文字列 | 0:1 | 半角英数字 64文字以内 | メールAPIで設定した tracking の label3 要素の値 |
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| jsonリクエストのバリデーションエラー | 400 |
| 認証失敗 | 401 |
| 実行中の同種別ジョブが多すぎる | 403 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| job_id | 数値 | 1 | ジョブID |