Statistics

Statistics は、送信したメールに関する統計情報を取得する操作を提供します。このAPIは管理コンソールが提供します。

list

Statistics/list は、送信したメールに関する統計情報を取得する操作を提供します。

リクエスト

/transaction/v1/statistics/list.[json|xml]

アクセス制御

項目	値
ロール	APIグループ管理者、APIユーザ
権限	データ参照許可

パラメータ

パラメータ	必須	データ型	説明
api_user	Yes	ASCII	ユーザ認証に使用するIDを指定します。
api_key	Yes	ASCII	ユーザ認証に使用するシークレットキーを指定します。
server_composition	No	UTF-8	操作の対象となるサーバ構成の名称を指定します。
year	Yes	INTEGER	統計情報を取得する年(yyyy形式)を指定します。
month	Yes	INTEGER	統計情報を取得する月(mm形式)を指定します。
total	No	BOOLEAN	true を指定した場合、year, month で指定した年月のサマリーデータを１レコードで応答します。レスポンスメッセージの date パラメータには、文字列 "total" を出力します。

レスポンス

JSONXML

{
"statistics": [
    {
    "date": "2015-12-01",
    "queued": 7833,
    "succeeded": 7800,
    "failed": 33,
    "blocked": 0,
    "valid": 7833
    },
    {
    "date": "2015-12-02",
    "queued": 649,
    "succeeded": 605,
    "failed": 40,
    "blocked": 4,
    "valid": 645
    },
    ...
]
}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<statistics>
<statistic>
    <date>2015-12-01</date>
    <queued>7833</queued>
    <succeeded>7800</succeeded>
    <failed>33</failed>
    <blocked>0</blocked>
    <valid>7833</valid>
</statistic>
<statistic>
    <date>2015-12-02</date>
    <queued>649</queued>
    <succeeded>605</succeeded>
    <failed>40</failed>
    <blocked>4</blocked>
    <valid>645</valid>
</statistic>
....
<statistics>

プロパティ	説明
date	統計データの集計日 (YYYY-MM-DD形式)
queued	集計日に受信したメールの件数
succeeded	集計日に送信成功したメールの件数
failed	集計日に送信エラーとなったメールの件数
blocked	配信停止リストにマッチしたため送信抑止したメールの件数
valid	有効なメール件数 = succeeded + failed

エラーメッセージ

フィールド	エラーコード	メッセージ (en)	メッセージ (ja)
server_composition	10-002	Specified server composition, {0}, was not found.	指定されたサーバ構成 {0} は存在しません。
status	13-001	The specified {0} status is not defined.	指定されたステータス {0} は定義されていません。
year	13-002	Future date cannot be specified.	将来の日付は指定できません。
month	13-002	Future date cannot be specified.	将来の日付は指定できません。

リクエスト例

curl -X POST -d 'api_user=testuser' -d 'api_key=password' -d 'server_composition=sandbox' -d 'year=2020' -d 'month=01' https://api.smtps.jp/transaction/v1/statistics/list.json