Email Logs API
直近30日間に送信したメールの送信状況やイベントの情報を取得できます。
Filter messages by ID [GET]
特定のメールのログを取得します。メールの指定に必要なsg_message_idパラメータの値は、Filter all messagesエンドポイントで取得できます。
| URI引数 | 必須 | 条件 | 説明 |
|---|---|---|---|
| sg_message_id | Yes | string | 取得対象とするメールのメッセージID (SendGrid Message ID) |
| subuser | No | string | サブユーザのAccount ID (サブユーザでログインするとAccount Details画面で確認できます。サブユーザ名ではありません。) 親アカウントのAPIキーでサブユーザの情報を取得する場合に指定 |
Request
1
| |
Response
| JSONパラメータ | 型 | 制限 | 詳細 | |
|---|---|---|---|---|
| from_email | string | |||
| 送信元メールアドレス | ||||
| sg_message_id | string | |||
| メッセージID(SendGrid Message ID) | ||||
| subject | string | |||
| メールの件名 | ||||
| to_email | string | |||
| 宛先メールアドレス | ||||
| status | string | processed, delivered, deferred, dropped, bounced, blocked のいずれか |
||
| メールの送信状況 | ||||
| template_id | string | |||
| 使用しているメールテンプレートのID | ||||
| asm_group_id | integer | |||
| 使用している配信停止グループのID | ||||
| api_key_id | string | |||
| 使用しているAPIキーのID | ||||
| events | オブジェクト配列 | 最大100件 | ||
| 各メッセージに関連するイベント情報(最新のイベントから最大100件) | ||||
| client_ip | string | |||
| メール送信をリクエストした環境のIPアドレス | ||||
| category | 配列 | |||
| メールに関連付けたカテゴリ | ||||
| custom_args | オブジェクト | |||
| メールに関連付けたユニーク引数 | ||||
| outbound_ip | string | |||
| メールの送信元IPアドレス | ||||
| outbound_ip_type | string | dedicated, shared のいずれか |
||
| 送信元IPアドレスの種類(固定IPアドレスまたは共有IPアドレス) | ||||
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 | |
Filter all messages [POST]
検索条件を指定し、条件にあてはまるメールの一覧を取得します。
検索条件を指定しない場合は、リクエストボディに空のJSON({})を指定してください。
Request
1
| |
Request Body
| JSONパラメータ | 型 | 制限 | 詳細 | |
|---|---|---|---|---|
| query | string | |||
| 検索条件を指定するクエリ 使用可能なクエリはこちら |
||||
| limit | integer | 1~1,000 | ||
| 取得する結果の件数上限 Default:10 |
||||
| subusers | 配列 | 1回の呼び出しにつき1つのみ | ||
| サブユーザのAccount ID (サブユーザでログインするとAccount Details画面で確認できます。サブユーザ名ではありません。) 親アカウントのAPIキーでサブユーザの情報を取得する場合に指定 |
||||
1 2 3 4 5 | |
Response
| JSONパラメータ | 型 | 制限 | 詳細 | |
|---|---|---|---|---|
| messages | オブジェクト配列 | |||
| from_email | string | |||
| 送信元メールアドレス | ||||
| sg_message_id | string | |||
| メッセージID(SendGrid Message ID) | ||||
| subject | string | |||
| メールの件名 | ||||
| to_email | string | |||
| 宛先メールアドレス | ||||
| reason | string | |||
| イベントの原因に関する説明 | ||||
| status | string | processed, delivered, deferred, dropped, bounced, blocked のいずれか |
||
| メールの送信状況 | ||||
| sg_message_id_created_at | string | ISO 8601フォーマット(YYYY-MM-DDThh:mm:ss) | ||
| メッセージIDが作成された時刻 | ||||
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |