General Statistics

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

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

Retrieve Statistics

daysパラメータまたはstart_dateとend_dateパラメータのいずれかを使用できます。パラメータが指定されなかった場合、今日の統計結果が返ります。

Retrieve Statistics

URI引数 必須 条件 説明
days false 1～1095の整数 詳細な統計を取得する日数（当日を含む）を指定します
start_date false YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 統計をとる開始日を指定します
end_date false YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 統計をとる終了日を指定します
aggregate false 0 または 1 合計を取るか否かを表します
category false 存在するカテゴリもしくはカテゴリの配列 詳細な情報を取得するカテゴリ
Parameter Value Requirements Description 
1

2784575556

Call

POST https://api.sendgrid.com/api/stats.get.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&days=2

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

[
   {
      "date": "2014-02-26",
      "delivered": 314,
      "unsubscribes": 1,
      "invalid_email": 5,
      "bounces": 9,
      "repeat_unsubscribes": 2,
      "unique_clicks": 65,
      "blocked": 3,
      "spam_drop": 5,
      "repeat_bounces": 8,
      "repeat_spamreports": 9,
      "requests": 350,
      "spamreports": 1,
      "clicks": 78,
      "opens": 80,
      "unique_opens": 70
   },
   {
      "date": "2014-02-27",
      "delivered": 271,
      "unsubscribes": 8,
      "invalid_email": 2,
      "bounces": 8,
      "repeat_unsubscribes": 1,
      "unique_clicks": 82,
      "blocked": 8,
      "spam_drop": 4,
      "repeat_bounces": 5,
      "repeat_spamreports": 9,
      "requests": 308,
      "spamreports": 0,
      "clicks": 103,
      "opens": 90,
      "unique_opens": 83
   }
]

Call

POST https://api.sendgrid.com/api/stats.get.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&days=2

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

<stats>
  <day>
      <date>2014-02-26</date>
      <delivered>314</delivered>
      <unsubscribes>1</unsubscribes>
      <invalid_email>5</invalid_email>
      <bounces>9</bounces>
      <repeat_unsubscribes>2</repeat_unsubscribes>
      <unique_clicks>65</unique_clicks>
      <blocked>3</blocked>
      <spam_drop>5</spam_drop>
      <repeat_bounces>8</repeat_bounces>
      <repeat_spamreports>9</repeat_spamreports>
      <requests>350</requests>
      <spamreports>1</spamreports>
      <clicks>78</clicks>
      <opens>80</opens>
      <unique_opens>70</unique_opens>
   </day>
   <day>
      <date>2014-02-27</date>
      <delivered>271</delivered>
      <unsubscribes>8</unsubscribes>
      <invalid_email>2</invalid_email>
      <bounces>8</bounces>
      <repeat_unsubscribes>1</repeat_unsubscribes>
      <unique_clicks>82</unique_clicks>
      <blocked>8</blocked>
      <spam_drop>4</spam_drop>
      <repeat_bounces>5</repeat_bounces>
      <repeat_spamreports>9</repeat_spamreports>
      <requests>308</requests>
      <spamreports>0</spamreports>
      <clicks>103</clicks>
      <opens>90</opens>
      <unique_opens>83</unique_opens>
   </day>
</stats>

応答内の用語についてはStatisticsを参照してください。

Category List

アカウントで使用している全てのカテゴリリストを取得します。

Parameter Value Requirements Description 
1

4212824797

Call

POST https://api.sendgrid.com/api/stats.get.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&list=true

Response

1
2
3
4
5
6
7
8
9
10
11

[
  {
    "category": "categoryA"
  },
  {
    "category": "categoryB"
  },
  {
    "category": "categoryC"
  }
]

Call

POST https://api.sendgrid.com/api/stats.get.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&list=true

Response

1
2
3
4
5

<categories>
   <category>categoryA</category>
   <category>categoryB</category>
   <category>categoryC</category>
</categories>