イベント集計ジョブ結果

機能説明

イベント集計ジョブの結果を取得します。
他のジョブ結果取得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 リクエストで指定した起点日時
unit 文字列 1 リクエストで指定した集計単位
range 数値 1 リクエストで指定した集計範囲
mid 文字列 0:1 リクエストで指定したmid
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リレー経由でメールを受け取り、キューイングされた
time 文字列 1 各オブジェクトごとの集計開始時間
amount 数値 1
イベントが発生した数

取得した中で最新のデータについては、timeからstart_atまでの期間で集計した数になります。
そうでないものは、timeから次に新しいtimeまでの期間で集計した数になります。
 
成功
{
  "data":[
    {
      "status":"Blacklisted",
      "time":"2018-11-05 17:00:00",
      "amount":0
    },
    {
      "status":"Bounced",
      "time":"2018-11-05 17:00:00",
      "amount":0
    },
    {
      "status":"Deferred",
      "time":"2018-11-05 17:00:00",
      "amount":0
    },
    {
      "status":"Delivered",
      "time":"2018-11-05 17:00:00",
      "amount":1
    },
    {
      "status":"Dropped",
      "time":"2018-11-05 17:00:00",
      "amount":0
    },
    {
      "status":"Processed",
      "time":"2018-11-05 17:00:00",
      "amount":1
    },
    {
      "status":"Relayed",
      "time":"2018-11-05 17:00:00",
      "amount":0
    },
    {
      "status":"SpamReport",
      "time":"2018-11-05 17:00:00",
      "amount":0
    },
    {
      "status":"Blacklisted",
      "time":"2018-11-05 16:00:00",
      "amount":0
    },
    {
      "status":"Bounced",
      "time":"2018-11-05 16:00:00",
      "amount":0
    },
    {
      "status":"Deferred",
      "time":"2018-11-05 16:00:00",
      "amount":0
    },
    {
      "status":"Delivered",
      "time":"2018-11-05 16:00:00",
      "amount":1
    },
    {
      "status":"Dropped",
      "time":"2018-11-05 16:00:00",
      "amount":0
    },
    {
      "status":"Processed",
      "time":"2018-11-05 16:00:00",
      "amount":1
    },
    {
      "status":"Relayed",
      "time":"2018-11-05 16:00:00",
      "amount":0
    },
    {
      "status":"SpamReport",
      "time":"2018-11-05 16:00:00",
      "amount":0
    },
    {
      "status":"Blacklisted",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"Bounced",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"Deferred",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"Delivered",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"Dropped",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"Processed",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"Relayed",
      "time":"2018-11-05 15:00:00",
      "amount":0
    },
    {
      "status":"SpamReport",
      "time":"2018-11-05 15:00:00",
      "amount":0
    }
  ],
  "start_at":"2018-11-05 17:59:59",
  "unit":"hour",
  "range":3,
  "mid":"420991132721754355",
  "batch_id":"example.0000001"
  "label1":"label1",
  "label2":"label2",
  "label3":"label3"
}