機能説明
トラッキング集計ジョブの結果を取得します。
他のジョブ結果取得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 |
トラッキング集計
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| url | 文字列 | 1 |
クリックトラッキングの対象となったURL
開封の場合はbeacon |
| mark | 文字列 | 1 |
クリックが発生したパート
textパートもしくはhtml パート 開封の場合は空 |
| time | 文字列 | 1 | クリック・開封が発生した日時 |
| amount | 数値 | 1 | クリック・開封が発生した数 |
成功
{
"data":[
{
"url":"beacon",
"mark":"",
"time":"2018-11-05 17:00:00",
"amount":1
},
{
"url":"https://example.org",
"mark":"html",
"time":"2018-11-05 17:00:00",
"amount":2
},
{
"url":"https://example.org",
"mark":"text",
"time":"2018-11-05 17:00:00",
"amount":0
},
{
"url":"beacon",
"mark":"",
"time":"2018-11-05 16:00:00",
"amount":1
},
{
"url":"https://example.org",
"mark":"html",
"time":"2018-11-0516:00:00",
"amount":1
},
{
"url":"https://example.org",
"mark":"text",
"time":"2018-11-0516:00:00",
"amount":0
},
{
"url":"beacon",
"mark":"",
"time":"2018-11-05 15:00:00",
"amount":0
},
{
"url":"https://example.org",
"mark":"html",
"time":"2018-11-05 15:00:00",
"amount":0
},
{
"url":"https://example.org",
"mark":"text",
"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"
}