バッチID別トラッキング集計

トラッキング設定が有効な配信のバッチID毎の、指定した期間のクリック・開封の結果を集計して取得する。

集計データの件数が10000件を超えるとエラーを返す。

集計データは1年間保持される。

リクエスト

エンドポイント

/v1/archives/trackings

HTTPメソッド

POST

リクエストボディ

JSON形式であること

要素名
型
要素数
制限
説明
start_at 文字列 1 YYYY-MM-DD hh:mm:ss の形式であること 集計開始日時
end_at 文字列 1 YYYY-MM-DD hh:mm:ss の形式であること リクエストで指定した集計終了日時
batch_ids 文字列の配列 0:* 各要素が半角英数字 64文字以内であること

集計対象とするバッチIDのリスト
未指定の場合はバッチIDが設定されていないクリック・開封が集計の対象となる

レスポンス

ステータスコード
状態
コード
成功 200
リクエストボディがjsonではない 400
jsonリクエストのバリデーションエラー 400
認証失敗 401
レスポンスに含まれるデータ件数が多すぎる 403
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504

レスポンスボディ

要素名
型
要素数
説明
code 数値 1 ステータスコード
data バッチID別トラッキング集計型の配列 0:10000 バッチID別トラッキング集計
start_at 文字列 1 リクエストで指定した集計開始日時
end_at 文字列 1 リクエストで指定した集計終了日時
batch_ids 文字列の配列 0:*

集計対象とするバッチID
未指定の場合はバッチIDが設定されていないクリック・開封の集計
バッチID別トラッキング集計
要素名
型
要素数
説明
batch_id 文字列 1 バッチID
url 文字列 1

クリックトラッキングの対象となったURL
開封の場合は beacon
mark 文字列 1

クリックが発生したパート
text パートもしくは html パート
開封の場合は空
amount 数値 1 クリック・開封が発生した数
成功

{
  "start_at": "2019-07-01 00:00:00",
  "end_at": "2019-07-31 23:59:59",
  "batch_ids": ["batchid01", "batchid02", "batchid03"],
  "data": [
    {"batch_id": "batchid01", "url": "https://example.com", "mark": "html", "amount": 293},
    {"batch_id": "batchid01", "url": "https://example.jp", "mark": "html", "amount": 32},
    {"batch_id": "batchid01", "url": "beacon", "mark": "", "amount": 2812},
    {"batch_id": "batchid02", "url": "https://example.com", "mark": "text", "amount": 546},
    {"batch_id": "batchid02", "url": "https://example.jp", "mark": "html", "amount": 615},
    {"batch_id": "batchid02", "url": "beacon", "mark": "", "amount": 15239},
  ]
}