Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface 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).

Hierarchy

  • DomainDeliverabilityCampaign

Properties

CampaignId?: string

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.

DeleteRate?: number

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.

Esps?: string[]

The major email providers who handled the email message.

FirstSeenDateTime?: Date

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.

FromAddress?: string

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

ImageUrl?: string

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

InboxCount?: number

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

LastSeenDateTime?: Date

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.

ProjectedVolume?: number

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

ReadDeleteRate?: number

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.

ReadRate?: number

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.

SendingIps?: string[]

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

SpamCount?: number

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

Subject?: string

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