PinpointEmail / Client / get_domain_deliverability_campaign

get_domain_deliverability_campaign#

PinpointEmail.Client.get_domain_deliverability_campaign(**kwargs)#

Retrieve all 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).

See also: AWS API Documentation

Request Syntax

response = client.get_domain_deliverability_campaign(
    CampaignId='string'
)
Parameters:

CampaignId (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'DomainDeliverabilityCampaign': {
        'CampaignId': 'string',
        'ImageUrl': 'string',
        'Subject': 'string',
        'FromAddress': 'string',
        'SendingIps': [
            'string',
        ],
        'FirstSeenDateTime': datetime(2015, 1, 1),
        'LastSeenDateTime': datetime(2015, 1, 1),
        'InboxCount': 123,
        'SpamCount': 123,
        'ReadRate': 123.0,
        'DeleteRate': 123.0,
        'ReadDeleteRate': 123.0,
        'ProjectedVolume': 123,
        'Esps': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    An object that contains all 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).

    • DomainDeliverabilityCampaign (dict) –

      An object that contains the deliverability data for the campaign.

      • 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.

      • ImageUrl (string) –

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

      • Subject (string) –

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

      • FromAddress (string) –

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

      • SendingIps (list) –

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

        • (string) –

          A dedicated IP address that is associated with your Amazon Pinpoint account.

      • FirstSeenDateTime (datetime) –

        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.

      • LastSeenDateTime (datetime) –

        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.

      • InboxCount (integer) –

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

      • SpamCount (integer) –

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

      • ReadRate (float) –

        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.

      • DeleteRate (float) –

        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.

      • ReadDeleteRate (float) –

        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.

      • ProjectedVolume (integer) –

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

      • Esps (list) –

        The major email providers who handled the email message.

        • (string) –

Exceptions