Advanced Statistics

このエンドポイントを含むWeb API v2の機能は、2025年2月に提供を終了します。

今後はWeb API v3をご利用ください。

ブラウザ、クライアント、デバイス、位置情報、グローバル、ISPなど詳細な統計を取得することができます。

Get Statistics for: Browsers, Clients, Devices, Geo, Global, Isp

URI引数 必須 条件 説明
data_type Yes 以下のうち一つを指定します:
browsers: クリックイベントから得られるブラウザデータ
clients: Openイベントから得られるメールクライアントデータ
devices: Openイベントから得られるデバイスデータ
geo: 複数のイベントから得られる地理的データ
global: 複数のイベントから得られるグローバルアカウントデータ
isps: 複数のイベントから得られるISPデータ
start_date Yes aggregated_byの値に基づいた日付フォーマット(デフォルトはyyyy-mm-dd):
aggregated_by=day の場合(デフォルト) : yyyy-mm-dd (i.e 2012-12-13)
aggregated_by=weekの場合 : yyyy-ww (i.e 2012-43)
aggregated_by=monthの場合 : yyyy-mm (i.e 2012-11)
end_date No aggregated_byの値に基づいた日付フォーマット(デフォルトはyyyy-mm-dd):
aggregated_by=dayの場合 (デフォルト) : yyyy-mm-dd (i.e 2012-12-13)
aggregated_by=weekの場合 : yyyy-ww (i.e 2012-43)
aggregated_by=monthの場合 : yyyy-mm (i.e 2012-11)
metric No 以下のうちいずれか (デフォルトは all):
open: オープン
click: クリック
unique_open: ユニークオープン
unique_click: ユニーククリック
processed: 処理されたメール
delivered: 配信されたメール
drop: ドロップされたメール
bounce: バウンスされたメール
deferred: 遅延したメール
spamreport: 迷惑メールとしてマークされたメール
blocked: ブロックされたメール
all: 全てのメトリックを返す
category No 指定されたカテゴリによる統計結果を返します
aggregated_by No 指定された期間で集計を行います(デフォルトは day ):
day: キーはyyyy-mm-dd形式(i.e 2012-12-13)で返されます
week: キーはyyyy-ww形式(i.e 2012-43) で返されます
month: キーはyyyy-mm形式(i.e 2012-11)で返されます
country No 指定された国の地域/州ごとに統計を取ります。現在、 US (米国)と CA (カナダ)のみがサポートされています。国コードはISO 3166-1 alpha-2に基づいた2桁の文字列です。このパラメータはdata_type=geoの場合のみ使用されます。
Parameter Value Requirements Description
1
8347866395

Call

POST https://api.sendgrid.com/api/stats.getAdvanced.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&start_date=2013-01-01&end_date=2013-01-02&data_type=global

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
  {
    "delivered": 41,
    "request": 41,
    "unique_open": 1,
    "unique_click": 1,
    "processed": 41,
    "date": "2013-01-01",
    "open": 2,
    "click": 1
  },
  {
    "delivered": 224,
    "unique_open": 1,
    "request": 224,
    "processed": 224,
    "date": "2013-01-02",
    "open": 3
  }
]

Call

POST https://api.sendgrid.com/api/stats.getAdvanced.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&start_date=2013-01-01&end_date=2013-01-02&data_type=global

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<stats>
   <day>
      <delivered>41</delivered>
      <request>41</request>
      <unique_open>1</unique_open>
      <unique_click>1</unique_click>
      <processed>41</processed>
      <date>2013-01-01</date>
      <open>2</open>
      <click>1</click>
   </day>
   <day>
      <delivered>224</delivered>
      <unique_open>1</unique_open>
      <request>224</request>
      <processed>224</processed>
      <date>2013-01-02</date>
      <open>3</open>
   </day>
</stats>