Subuser Stats

Subuser Statsではサブユーザ毎の統計情報を取得することができます。

GET

指定したサブユーザ毎の統計情報を取得します。subusersで指定可能なサブユーザの上限は10です。

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

Request

1
GET https://api.sendgrid.com/v3/subusers/stats?subusers={subusers}&subusers={subusers}&start_date={start_date}&end_date={end_date}&aggregated_by={aggregated_by} 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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
HTTP/1.1 200
[
  {
    "date": "2015-01-01",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        },
        "name": "user1",
        "type": "subuser"
      },
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        },
        "name": "user2",
        "type": "subuser"
      }
    ]
  },
  {
    "date": "2015-01-02",
    "stats": [
      {
        "metrics": {
          "blocks": 10,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 10,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        },
        "name": "user1",
        "type": "subuser"
      },
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 6,
          "deferred": 0,
          "delivered": 5,
          "invalid_emails": 0,
          "opens": 6,
          "processed": 0,
          "requests": 5,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 5,
          "unique_opens": 5,
          "unsubscribe_drops": 0,
          "unsubscribes": 6
        },
        "name": "user2",
        "type": "subuser"
      }
    ]
  }
]

GET

全てのサブユーザについてメトリクス事の合計値を取得します。

URI引数 必須 条件 説明
start_date Yes YYYY-mm-dd形式 情報を取得する開始日
end_date No YYYY-mm-dd形式 情報を取得する終了日。指定しない場合:今日
aggregated_by No [day|week|month] 統計のグループ化の指定
sort_by_metric No 単一メトリック ソートするメトリックを指定します。指定しない場合:delivered
sort_by_direction No [desc|asc] ソートの並びを指定します。指定しない場合:desc
limit No 整数 結果を取得する件数を制限します。指定しない場合:5
offset No 整数 結果を取得する位置のオフセットを指定します。指定しない場合:0

Request

1
GET https://api.sendgrid.com/v3/subusers/stats/sums?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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
HTTP/1.1 200
{
  "date": "2015-01-01",
  "stats": [
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 20,
        "deferred": 0,
        "delivered": 20,
        "invalid_emails": 0,
        "opens": 20,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 20,
        "unique_opens": 20,
        "unsubscribe_drops": 0,
        "unsubscribes": 20
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "metrics": {
        "blocks": 1,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 19,
        "deferred": 0,
        "delivered": 19,
        "invalid_emails": 0,
        "opens": 19,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 19,
        "unique_opens": 19,
        "unsubscribe_drops": 0,
        "unsubscribes": 19
      },
      "name": "user2",
      "type": "subuser"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 5,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 5
      },
      "name": "user3",
      "type": "subuser"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 6,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 6,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 6
      },
      "name": "user4",
      "type": "subuser"
    },
    {
      "metrics": {
        "blocks": 10,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 0,
        "processed": 0,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user5",
      "type": "subuser"
    }
  ]
}

GET

指定した期間における全サブユーザについての月次統計情報を取得します。

sort_by_metricでは、以下のメトリックを指定して統計情報をソートすることはできません: bounce_drops, deferred, invalid_emails, processed, spam_report_drops, spam_reports, および unsubscribe_drops

URI引数 必須 条件 説明
date Yes YYYY-MM-DD形式 統計情報を取得する月の日付
subuser No String サブユーザを検索するための文字列(部分一致)
sort_by_metric No 単一メトリック ソート対象のメトリック。デフォルト値:delivered。他に指定可能なメトリック: blocks, bounces, clicks, delivered, opens, requests, unique_clicks, unique_opens, および unsubscribes.
sort_by_direction No [desc|asc] ソート方向。デフォルト値:desc
limit No 整数 結果を取得する件数を制限します。デフォルト値:5
offset No 整数 結果を取得する位置のオフセットを指定します。デフォルト値:0

Request

1
GET /subusers/stats/monthly?date={date}&subuser={subuser}&sort_by_metric={sort_by_metric}&sort_by_direction={sort_by_direction}&limit={limit}&offset={offset} 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
46
47
48
49
50
51
52
53
54
55
HTTP/1.1 200

{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 1,
          "processed": 0,
          "requests": 100,
          "spam_report_drops": 0,
          "spam_reports": 99,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 5,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 10,
          "processed": 10,
          "requests": 10,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}

GET

指定したサブユーザについての月次統計情報を取得します。

sort_by_metricでは、以下のメトリックを指定して統計情報をソートすることはできません: bounce_drops, deferred, invalid_emails, processed, spam_report_drops, spam_reports, および unsubscribe_drops.

URI引数 必須 条件 説明
date Yes YYYY-MM-DD形式 統計情報を取得する月の日付
sort_by_metric No 単一メトリック ソート対象のメトリック。デフォルト値:delivered。他に指定可能なメトリック: blocks, bounces, clicks, delivered, opens, requests, unique_clicks, unique_opens, および unsubscribes.
sort_by_direction No [desc|asc] ソート方向。デフォルト値:desc
limit No 整数 結果を取得する件数を制限します。デフォルト値:5
offset No 整数 結果を取得する位置のオフセットを指定します。デフォルト値:.

Request

1
GET /subusers/:subuser_name/stats/monthly?date={date}&subuser={subuser}&sort_by_metric={sort_by_metric}&sort_by_direction={sort_by_direction}&limit={limit}&offset={offset} 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
HTTP/1.1 200

{
  "date": "2016-02-01",
  "stats": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "metrics": {
            "blocks": 0,
            "bounce_drops": 0,
            "bounces": 0,
            "clicks": 5,
            "deferred": 0,
            "delivered": 0,
            "invalid_emails": 0,
            "opens": 10,
            "processed": 10,
            "requests": 10,
            "spam_report_drops": 0,
            "spam_reports": 0,
            "unique_clicks": 0,
            "unique_opens": 0,
            "unsubscribe_drops": 0,
            "unsubscribes": 0
        },
        "name": "user1",
        "type": "subuser"
      }
  ]
}