期間内イベント別集計ジョブ結果

期間内イベント別集計ジョブの結果を取得する。

他のジョブ結果取得APIと共通のエンドポイントを使用する。

ジョブ結果の取得期限はジョブをリクエストしてから24時間。

リクエスト

エンドポイント

/v2/jobs/[ジョブID]

HTTPメソッド

GET

リクエストボディ

なし

レスポンス

ステータスコード
状態
コード
成功 200
ジョブIDが不正 400
認証失敗 401
存在しないエンドポイント 404
存在しないジョブID 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
要素名
要素数
説明
code 数値 1 ステータスコード
status 文字列 1

ジョブの状態
success 実行完了
running 実行中

data イベント別集計の配列 0:* イベント別集計
start_at 文字列 1 リクエストで指定した起点日時
end_at 文字列 1 リクエストで指定した終点日時
batch_id 文字列 0:1 リクエストで指定した batch_id
label1 文字列 0:1 リクエストで指定した label1
label2 文字列 0:1 リクエストで指定した label2
label3 文字列 0:1 リクエストで指定した label3

イベント別集計

要素名
要素数
説明
status 文字列 1

発生したイベントのステータス
Processed 処理を開始した
Delivered 送信に成功した
Deferred (実際のイベント件数にかかわらず、"amount":0で表示される)
Bounced 恒久的に送信に失敗した
Dropped 配信停止アドレスに登録された宛先への送信を中止した
SpamReport 送信先からスパムと判定された
Blacklisted ブラックリストに登録された宛先への送信を中止した
Relayed SMTPリレー経由でメールを受け取り、キューイングされた

amount 数値 1

イベントが発生した数

成功

{
  "start_at": "2018-11-01 00:00:00",
  "end_at": "2018-11-30 00:00:00",
  "data": [
    {
      "status": "Processed",
      "amount": 9
    },
    {
      "status": "Deferred",
      "amount": 0
    },
    {
      "status": "Delivered",
      "amount": 9
    },
    {
      "status": "Dropped",
      "amount": 0
    },
    {
      "status": "SpamReport",
      "amount": 0
    },
    {
      "status": "Bounced",
      "amount": 0
    },
    {
      "status": "Blacklisted",
      "amount": 0
    },
    {
      "status": "Relayed",
      "amount": 0
    }
  ],
  "code": 200
}