Advanced Stats

Advanced Statsでは、位置情報、ブラウザタイプなど、より詳細な統計情報を取得することができます。各メトリクスの詳細についてはこちらを参照してください。

GET

国毎の統計情報を取得します。

URI引数 必須 条件 説明
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定
country No [US|CA] 統計情報を取得する国。US(米国)とCA(カナダ)のみサポート。

Request

1
GET https://api.sendgrid.com/v3/geo/stats?start_date=2015-01-01&end_date=2015-01-02 HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
HTTP/1.1 200
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        },
        "name": "US",
        "type": "country"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        },
        "name": "US",
        "type": "country"
      }
    ]
  }
]

GET

デバイスタイプ毎の統計情報を取得します。

指定可能なデバイスタイプ:

デバイス 説明
Desktop デスクトップコンピュータ上で動作するメールソフトウェア(例:Outlook、Sparrow、Apple Mailなど)
Webmail Webベースのメールクライアント(例:Yahoo!、Google、AOL、Outlook.comなど)
Phone スマートフォン(iPhone、Android、Blackberryなど)
Tablet タブレット端末(iPad、Androidベースのタブレットなど)
Other 不明なデバイス
URI引数 必須 条件 説明
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定

Request

1
GET https://api.sendgrid.com/v3/devices/stats?start_date=2015-01-01&end_date=2015-01-02&aggregated_by=week HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
HTTP/1.1 200
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Webmail",
        "type": "device"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Webmail",
        "type": "device"
      }
    ]
  }
]

GET

クライアントタイプ毎の統計情報を取得します。

URI引数 必須 条件 説明
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定

Request

1
GET https://api.sendgrid.com/v3/clients/stats?start_date=2015-01-01&end_date=2015-01-02&aggregated_by=week HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
HTTP/1.1 200
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]

GET

指定したクライアントタイプの統計情報を取得します。

URI引数 必須 条件 説明
client_type Yes [phone|tablet|webmail|desktop] 情報を取得するクライアントタイプ
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定

Request

1
GET https://api.sendgrid.com/v3/clients/:client_type/stats?start_date=2015-01-01&end_date=2015-01-02&aggregated_by=week HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
HTTP/1.1 200
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]

GET

メールボックスプロバイダー毎の統計情報を取得します。

URI引数 必須 条件 説明
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定
mailbox_providers No 文字列配列 統計情報を取得するメールボックスプロバイダ。最大10。

Request

1
GET https://api.sendgrid.com/v3/mailbox_providers/stats?start_date=2015-01-01&end_date=2015-01-02 HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
HTTP/1.1 200
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "blocks": 1,
          "bounces": 0,
          "clicks": 0,
          "deferred": 1,
          "delivered": 1,
          "drops": 0,
          "opens": 1,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "esp"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "esp"
      }
    ]
  }
]

GET

ブラウザ毎の統計情報を取得します。browsersパラメータを複数回使用することで複数ブラウザを指定することができます。

URI引数 必須 条件 説明
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定
browsers No 文字列配列 統計情報を取得するブラウザ。最大10。

Request

1
GET https://api.sendgrid.com/v3/browsers/stats?start_date=2015-01-01&end_date=2015-01-02&aggregated_by=week HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
HTTP/1.1 200
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]