Statistics

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

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

サブユーザの統計情報。

Retrieve Subuser Statistics

サブユーザの日次の統計情報を取得します。

days引数とstart_date/end_date引数を同時に使用することはできません。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ 統計情報を取得するサブユーザ
days No 正の整数 統計情報を取得する過去の日数（今日を含みます）
start_date No end_date以前のYYY-mm-dd形式 統計情報を取得する開始日を指定します
end_date No start_date以降のYYYY-mm-dd形式 統計情報を取得する終了日を指定します
Parameter Value Requirements Description 
1

1625783605

Call

POST https://api.sendgrid.com/apiv2/customer.stats.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

[
  {
    "date": "2014-11-27",
    "requests": 0,
    "delivered": 0,
    "bounces": 0,
    "repeat_bounces": 0,
    "unsubscribes": 0,
    "repeat_unsubscribes": 0,
    "clicks": 0,
    "opens": 0,
    "spamreports": 0,
    "repeat_spamreports": 0,
    "invalid_email": 0,
    "blocks": 0,
    "unique_clicks": 0,
    "unique_opens": 0
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.stats.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<stats>
  <day>
    <date>2014-11-29</date>
    <requests>0</requests>
    <delivered>0</delivered>
    <bounces>0</bounces>
    <repeat_bounces>0</repeat_bounces>
    <unsubscribes>0</unsubscribes>
    <repeat_unsubscribes>0</repeat_unsubscribes>
    <clicks>0</clicks>
    <opens>0</opens>
    <spamreports>0</spamreports>
    <repeat_spamreports>0</repeat_spamreports>
    <invalid_email>0</invalid_email>
    <blocks>0</blocks>
    <unique_clicks>0</unique_clicks>
    <unique_opens>0</unique_opens>
  </day>
</stats>

Retrieve Aggregate Statistics

全期間の合計を取得します。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ 統計情報を取得するサブユーザ
aggregate Yes 1を指定します 全期間の合計を取得することを示します
Parameter Value Requirements Description 
1

893552811

Call

POST https://api.sendgrid.com/apiv2/customer.stats.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&aggregate=1

Response

1
2
3
4
5
6
7

{
  "requests": "12342",
  "bounces": "12",
  "clicks": "10223",
  "opens": "9992",
  "spamreports": "5"
}

Call

POST https://api.sendgrid.com/apiv2/customer.stats.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&aggregate=1

Response

1
2
3
4
5
6
7

<stats>
   <requests>12342</requests>
   <bounces>12</bounces>
   <clicks>10223</clicks>
   <opens>9992</opens>
   <spamreports>5</spamreports>
</stats>

Category List

サブユーザのアカウントで使用されている全カテゴリのリストを取得します。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ 統計情報を取得するサブユーザ
list Yes trueを指定します サブユーザのアカウントで使用されている全カテゴリのリストを取得します
Parameter Value Requirements Description 
1

8374988718

Call

POST https://api.sendgrid.com/apiv2/customer.stats.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&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/apiv2/customer.stats.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&list=true

Response

1
2
3
4
5

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

Category Statistics

カテゴリ毎に詳細化された統計を取得します。カテゴリが存在しない場合、空の結果セットが返ります。

days引数とstart_date/end_date引数を同時に使用することはできません。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ 統計情報を取得するサブユーザ
category Yes 作成済みのカテゴリ 詳細化された統計情報を取得するカテゴリ
days No 正の整数 統計情報を取得する過去の日数（今日を含みます）
start_date No end_date以前のYYY-mm-dd形式 統計情報を取得する開始日を指定します
end_date No start_date以降のYYYY-mm-dd形式 統計情報を取得する終了日を指定します
Parameter Value Requirements Description 
1

2816648318

Call

POST https://api.sendgrid.com/apiv2/customer.stats.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&category=categoryA

Response

1
2
3
4
5
6
7
8
9
10
11

[
  {
    "date": "2009-06-20",
    "category": "categoryA",
    "requests": 12342,
    "bounces": 12,
    "clicks": 10223,
    "opens": 9992,
    "spamreports": 5
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.stats.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&category=categoryA

Response

1
2
3
4
5
6
7
8
9
10
11

<stats>
  <day>
    <date>2009-06-20</date>
    <category>categoryA</category>
    <requests>12342</requests>
    <bounces>12</bounces>
    <clicks>10223</clicks>
    <opens>9992</opens>
    <spamreports>5</spamreports>
  </day>
</stats>

Multiple Category Statistics

複数のカテゴリに関して統計情報を取得する場合、category引数に配列を使用することができます。

Parameter Value Requirements Description 
1

6682153496

Call

POST https://api.sendgrid.com/apiv2/customer.stats.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&category[]=categoryA&category[]=categoryB

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

[
  {
    "date": "2009-06-20",
    "category": "categoryA",
    "requests": 12342,
    "bounces": 12,
    "clicks": 10223,
    "opens": 9992,
    "spamreports": 5
  },
  {
    "date": "2009-06-21",
    "category": "categoryB",
    "requests": 32342,
    "bounces": 10,
    "clicks": 14323,
    "opens": 10995,
    "spamreports": 7
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.stats.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&category[]=categoryA&category[]=categoryB

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<stats>
  <day>
    <date>2009-06-20</date>
    <category>categoryA</category>
    <requests>12342</requests>
    <bounces>12</bounces>
    <clicks>10223</clicks>
    <opens>9992</opens>
    <spamreports>5</spamreports>
  </day>
  <day>
      <date>2009-06-21</date>
      <category>categoryB</category>
      <requests>32342</requests>
      <bounces>10</bounces>
      <clicks>14323</clicks>
      <opens>10995</opens>
      <spamreports>7</spamreports>
  </day>
</stats>