Alerts API

本エンドポイントを利用することで、送信通数もしくは統計情報に基づいて指定した宛先にアラートを送信することができます。
  • 使用量アラートを利用することで、送信通数が設定したしきい値を超えた場合、アラートメールが送信されます。例えば、現プランの上限通数の90%を超えた場合に通知を送信する場合、"percentage"パラメータの値を90に設定してください。
  • 統計情報通知では統計レポートの受信頻度を指定できます。例えば、統計レポートを毎日受信する場合、"frequency"パラメータを"daily"に設定してください。統計情報通知には、日次のメールの送信通数に加えて、バウンス、ドロップ、配信停止などその他のイベントについての情報が含まれます。

アラートの詳細については、ユーザマニュアルを参照してください。

Get All Alerts [GET]

全アラートの一覧取得。

Request

1

GET https://api.sendgrid.com/v3/alerts 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

HTTP/1.1 200
[
  {
    "created_at": 1451498784,
    "email_to": "test@example.com",
    "id": 46,
    "percentage": 90,
    "type": "usage_limit",
    "updated_at": 1451498784
  },
  {
    "created_at": 1451498812,
    "email_to": "test@example.com",
    "frequency": "monthly",
    "id": 47,
    "type": "stats_notification",
    "updated_at": 1451498812
  },
  {
    "created_at": 1451520930,
    "email_to": "test@example.com",
    "frequency": "daily",
    "id": 48,
    "type": "stats_notification",
    "updated_at": 1451520930
  }
]

Create a New Alert [POST]

アラートを新規作成します。同じアラートは複数回作成できますが、"email_to"パラメータで異なる宛先を指定する必要があります。同じアラートをを複数の宛先に送信したい場合に有効な機能です。

Body引数 必須 条件 説明
type Yes string 作成するアラートのタイプです。usage_limitまたはstats_notificationいずれかを指定できます。usage_limitアラートを利用すると、指定した閾値を超えた場合にアラートが送信されます。stats_notificationアラートを利用すると、メールの統計レポートを受信する頻度を指定できます.
Example: usage_limit
email_to Yes string アラートメールの宛先です。.
Example: test@example.com
percentage No number usage_limitの場合必要となります。送信通数がこのしきい値に達した場合、アラートが送信されます.
Example: 90
frequency No string stats_notificationの場合必要となります。アラートの送信間隔を指定します.
Example: daily

Request

1

POST https://api.sendgrid.com/v3/alerts HTTP/1.1
Request Body
1
2
3
4
5

{
  "type": "stats_notification",
  "email_to": "test@example.com",
  "frequency": "daily"
}

Response

1
2
3
4
5
6
7
8
9

HTTP/1.1 201
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}

Get an Alert [GET]

特定のアラートを取得します。

Request

1

GET https://api.sendgrid.com/v3/alerts/{alert_id} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9

HTTP/1.1 200
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}

Delete an Alert [DELETE]

アラートを削除します。

Request

1

DELETE https://api.sendgrid.com/v3/alerts/{alert_id} HTTP/1.1

Response

1

HTTP/1.1 204

Update an Alert [PATCH]

アラートを更新します。

Body引数 必須 条件 説明
email_to No string アラートの宛先となる新しいメールアドレスです.
Example: test@example.com
frequency No string stats_notificationアラートで使用される新しい送信頻度です.
Example: monthly
percentage No number usage_limitアラートで使用される新しいしきい値(%)です.
Example: 90

Request

1

PATCH https://api.sendgrid.com/v3/alerts/{alert_id} HTTP/1.1
Request Body
1
2
3

{
  "email_to": "test@example.com"
}

Response

1
2
3
4
5
6
7
8
9

HTTP/1.1 200
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451522691
}