Email events
Before you can view your events you have to setup event streaming, see Setting up event streaming. When setting up event streaming you specify a destination for your event data to be saved to and then you can use the destination to retrieve your event data for viewing. When you send email messages, Amazon Pinpoint can stream data that provides additional information about the following types of events for those messages:
-
Sends
-
Deliveries
-
Bounces
-
Complaints
-
Opens
-
Clicks
-
Rejections
-
Unsubscribes
-
Rendering failures
The event types in the preceding list are explained in detail in Email event attributes.
Depending on the API and settings that you use to send email messages, you might see additional event types or different data. For example, if you send messages using configuration sets that publish event data to Amazon Kinesis, such as those provided by Amazon Simple Email Service (Amazon SES), the data can also include events for template-rendering failures. For information about that data, see Monitoring using Amazon SES event publishing in the Amazon Simple Email Service Developer Guide. Before you can view your events you have to setup event streaming, see Setting up event streaming. When setting up event streaming you specify a destination for your event data to be saved to and then you can use the destination to retrieve your event data for viewing.
Sample events
Email send
The JSON object for an email send event contains the data shown in the following example.
{ "event_type": "_email.send", "event_timestamp": 1564618621380, "arrival_timestamp": 1564618622025, "event_version": "3.1", "application": { "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "sdk": {} }, "client": { "client_id": "9a311b17-6f8e-4093-be61-4d0bbexample" }, "device": { "platform": {} }, "session": {}, "attributes": { "feedback": "received" }, "awsAccountId": "123456789012", "facets": { "email_channel": { "mail_event": { "mail": { "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000", "message_send_timestamp": 1564618621380, "from_address": "sender@example.com", "destination": ["recipient@example.com"], "headers_truncated": false, "headers": [{ "name": "From", "value": "sender@example.com" }, { "name": "To", "value": "recipient@example.com" }, { "name": "Subject", "value": "Amazon Pinpoint Test" }, { "name": "MIME-Version", "value": "1.0" }, { "name": "Content-Type", "value": "multipart/alternative; boundary=\"----=_Part_314159_271828\"" }], "common_headers": { "from": "sender@example.com", "to": ["recipient@example.com"], "subject": "Amazon Pinpoint Test" } }, "send": {} } } } }
Email delivered
The JSON object for an email delivered event contains the data shown in the following example.
{ "event_type": "_email.delivered", "event_timestamp": 1564618621380, "arrival_timestamp": 1564618622690, "event_version": "3.1", "application": { "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "sdk": {} }, "client": { "client_id": "e9a3000d-daa2-40dc-ac47-1cd34example" }, "device": { "platform": {} }, "session": {}, "attributes": { "feedback": "delivered" }, "awsAccountId": "123456789012", "facets": { "email_channel": { "mail_event": { "mail": { "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000", "message_send_timestamp": 1564618621380, "from_address": "sender@example.com", "destination": ["recipient@example.com"], "headers_truncated": false, "headers": [{ "name": "From", "value": "sender@example.com" }, { "name": "To", "value": "recipient@example.com" }, { "name": "Subject", "value": "Amazon Pinpoint Test" }, { "name": "MIME-Version", "value": "1.0" }, { "name": "Content-Type", "value": "multipart/alternative; boundary=\"----=_Part_314159_271828\"" }], "common_headers": { "from": "sender@example.com", "to": ["recipient@example.com"], "subject": "Amazon Pinpoint Test" } }, "delivery": { "smtp_response": "250 ok: Message 82080542 accepted", "reporting_mta": "a8-53.smtp-out.amazonses.com", "recipients": ["recipient@example.com"], "processing_time_millis": 1310 } } } } }
Email click
The JSON object for an email click event contains the data shown in the following example.
{ "event_type": "_email.click", "event_timestamp": 1564618621380, "arrival_timestamp": 1564618713751, "event_version": "3.1", "application": { "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "sdk": {} }, "client": { "client_id": "49c1413e-a69c-46dc-b1c4-6470eexample" }, "device": { "platform": {} }, "session": {}, "attributes": { "feedback": "https://aws.amazon.com/pinpoint/" }, "awsAccountId": "123456789012", "facets": { "email_channel": { "mail_event": { "mail": { "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000", "message_send_timestamp": 1564618621380, "from_address": "sender@example.com", "destination": ["recipient@example.com"], "headers_truncated": false, "headers": [{ "name": "From", "value": "sender@example.com" }, { "name": "To", "value": "recipient@example.com" }, { "name": "Subject", "value": "Amazon Pinpoint Test" }, { "name": "MIME-Version", "value": "1.0" }, { "name": "Content-Type", "value": "multipart/alternative; boundary=\"----=_Part_314159_271828\"" }, { "name": "Message-ID", "value": "null" }], "common_headers": { "from": "sender@example.com", "to": ["recipient@example.com"], "subject": "Amazon Pinpoint Test" } }, "click": { "ip_address": "72.21.198.67", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.2 Safari/605.1.15", "link": "https://aws.amazon.com/pinpoint/" } } } } }
Email open
The JSON object for an email open event contains the data shown in the following example.
{ "event_type": "_email.open", "event_timestamp": 1564618621380, "arrival_timestamp": 1564618712316, "event_version": "3.1", "application": { "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "sdk": {} }, "client": { "client_id": "8dc1f651-b3ec-46fc-9b67-2a050example" }, "device": { "platform": {} }, "session": {}, "attributes": { "feedback": "opened" }, "awsAccountId": "123456789012", "facets": { "email_channel": { "mail_event": { "mail": { "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000", "message_send_timestamp": 1564618621380, "from_address": "sender@example.com", "destination": ["recipient@example.com"], "headers_truncated": false, "headers": [{ "name": "From", "value": "sender@example.com" }, { "name": "To", "value": "recipient@example.com" }, { "name": "Subject", "value": "Amazon Pinpoint Test" }, { "name": "MIME-Version", "value": "1.0" }, { "name": "Content-Type", "value": "multipart/alternative; boundary=\"----=_Part_314159_271828\"" }, { "name": "Message-ID", "value": "null" }], "common_headers": { "from": "sender@example.com", "to": ["recipient@example.com"], "subject": "Amazon Pinpoint Test" } }, "open": { "ip_address": "72.21.198.67", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko)" } } } } }
Email event attributes
This section defines the attributes that are included in the event stream data that Amazon Pinpoint generates when you send email messages.
Attribute | Description |
---|---|
event_type |
The type of event. Possible values are:
|
event_timestamp |
The time when the message was sent, shown as Unix time in milliseconds. This value is typically the same for all the events that are generated for a message. |
arrival_timestamp |
The time when the event was received by Amazon Pinpoint, shown as Unix time in milliseconds. |
event_version |
The version of the event JSON schema. TipCheck this version in your event-processing application so that you know when to update the application in response to a schema update. |
application |
Information about the Amazon Pinpoint project that's associated with the event. See the Application table for more information. |
client |
Information about the app client that's installed on the device that reported the event. For more information, see the Client table. |
device |
Information about the device that reported the event. For more information, see the Device table. For email events, this object is empty. |
session |
For email events, this object is empty. |
attributes |
Attributes that are associated with the event. For more information, see the Attributes table. For events that are reported by one of your apps, this object can include custom attributes that are defined by the app. For events that are created when you send a message from a campaign or journey, this object contains attributes that are associated with the campaign or journey. For events that are generated when you send transactional messages, this object contains information that's related to the message itself. |
client_context |
For email events, this object contains a custom object,
which contains a legacy_identifier attribute. The value for
the legacy_identifier attribute is the ID of the project
that the message was sent from. |
facets |
Additional information about the message, such as the email headers. See the Facets table for more information. |
awsAccountId |
The ID of the AWS account that was used to send the message. |
Application
Includes information about the Amazon Pinpoint project that the event is associated with.
Attribute | Description |
---|---|
app_id |
The unique ID of the Amazon Pinpoint project that reported the event. |
sdk |
The SDK that was used to report the event. If you send a transactional email message by calling the Amazon Pinpoint API directly or by using the Amazon Pinpoint console, this object is empty. |
Attributes
Includes information about the campaign or journey that produced the event.
Campaign
Includes information about the campaign that produced the event.
Attribute | Description |
---|---|
feedback |
For |
treatment_id |
If the message was sent using an A/B test campaign, this
value represents the treatment number of the message. For
standard campaigns and transactional email messages, this
value is |
campaign_activity_id |
The unique ID that Amazon Pinpoint generates when the event occurs. |
campaign_id |
The unique ID of the campaign that sent the message. |
Journey
Includes information about the journey that produced the event.
Attribute | Description |
---|---|
journey_run_id |
The unique ID of the journey run that sent the message. Amazon Pinpoint generates and assigns this ID automatically to each new run of a journey. |
feedback |
For |
journey_id |
The unique ID of the journey that sent the message. |
journey_activity_id |
The unique ID of the journey activity that sent the message. |
Client
The unique identifier of the client that was targeted by the campaign or journey.
Attribute | Description |
---|---|
client_id |
The ID of the client. The value is the Endpoint ID for campaigns and journeys, and for Transactional sending, it is a UUID. |
Facets
Includes information about the message and the event type.
Attribute | Description |
---|---|
email_channel |
Contains a |
Includes information about the content of the email message, and metadata about the message.
Attribute | Description |
---|---|
message_id |
The unique ID of the message. Amazon Pinpoint automatically generates this ID when it accepts the message. |
message_send_timestamp |
The date and time when the message was sent, in the format
specified in RFC
822 |
from_address |
The email address that the message was sent from. |
destination |
An array that contains the email addresses that the message was sent to. |
headers_truncated |
A Boolean value that indicates whether the email headers were truncated. |
headers |
An object that contains several name-value pairs that correspond to the headers in the message. This object typically contains information about the following headers:
|
common_headers |
Contains information about several common headers for email messages. The information can include the date when the message was sent, and the to, from, and subject lines of the message. |