Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DomainDeliverabilityCampaign

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

Contents

CampaignId

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

Type: String

Required: No

DeleteRate

The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

Type: Double

Required: No

Esps

The major email providers who handled the email message.

Type: Array of strings

Required: No

FirstSeenDateTime

The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

Type: Timestamp

Required: No

FromAddress

The verified email address that the email message was sent from.

Type: String

Required: No

ImageUrl

The URL of an image that contains a snapshot of the email message that was sent.

Type: String

Required: No

InboxCount

The number of email messages that were delivered to recipients’ inboxes.

Type: Long

Required: No

LastSeenDateTime

The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

Type: Timestamp

Required: No

ProjectedVolume

The projected number of recipients that the email message was sent to.

Type: Long

Required: No

ReadDeleteRate

The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

Type: Double

Required: No

ReadRate

The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

Type: Double

Required: No

SendingIps

The IP addresses that were used to send the email message.

Type: Array of strings

Required: No

SpamCount

The number of email messages that were delivered to recipients' spam or junk mail folders.

Type: Long

Required: No

Subject

The subject line, or title, of the email message.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: