MessageEvents
List of events related to email message in SendGrid.
NOTE: If you want access to Email events, you must purchase the Email Activity History add-in of SendGrid. If using a Restricted Access key, you must give it the messages.read and email_activity.read scopes.
View-Specific Information
Select
The driver will use the SendGrid API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.- MessageId supports the '=' comparisons.
SQL
SELECT * FROM MessageEvents WHERE MessageId = '1234'
Columns
Name | Type | References | Description |
MessageId | String | The Id of the message. | |
EventName | String | Name of event.
The allowed values are bounced, opened, clicked, processed, dropped, delivered, deferred, spam_report, unsubscribe, group_unsubscribe, group_resubscribe. | |
Processed | Datetime | The date when the event was processed. | |
Reason | String | Explanation of what caused the message to be 'bounced', 'deferred', or 'blocked'. | |
AttemptNum | Integer | Used with 'deferred' events to indicate the attempt number out of 10. | |
Url | String | Used with 'clicked' event to indicate which url the user clicked. | |
BounceType | String | Use to distinguish between types of bounces.
The allowed values are soft, hard. | |
HttpUserAgent | String | Client recipient used to click or open message. | |
MXServer | String | The MX server that received the email. | |
ApiKeyId | String | Id of the API Key. | |
AsmGroupId | String | ASM Group Id. | |
Categories | String | Categories users associated to the message. | |
UniqueArgs | String | JSON hash of key-value pairs associated with the message. | |
OriginatingIp | String | This is the IP address of the person sending the message | |
OutboundIp | String | This is the SendGrid dedicated IP address used to send the email | |
OutboundIpType | String | The type of the outbound IP. | |
Teammate | String | Username of the teammate. | |
TemplateId | String | Template ID of the email. |