list_domain_deliverability_campaigns¶

PinpointEmail.Client.list_domain_deliverability_campaigns(**kwargs)¶

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard ( PutDeliverabilityDashboardOption operation) for the domain.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_deliverability_campaigns(
    StartDate=datetime(2015, 1, 1),
    EndDate=datetime(2015, 1, 1),
    SubscribedDomain='string',
    NextToken='string',
    PageSize=123
)

Parameters

StartDate (datetime) --
[REQUIRED]

The first day, in Unix time format, that you want to obtain deliverability data for.
EndDate (datetime) --
[REQUIRED]

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.
SubscribedDomain (string) --
[REQUIRED]

The domain to obtain deliverability data for.
NextToken (string) -- A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.
PageSize (integer) -- The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

Return type

dict

Returns

Response Syntax

{
    'DomainDeliverabilityCampaigns': [
        {
            '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',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard ( PutDeliverabilityDashboardOption operation) for the domain.
- DomainDeliverabilityCampaigns (list) --
  
  An array of responses, one for each campaign that used the domain to send email during the specified time range.
  - (dict) --
    
    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).
    - 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) --
- NextToken (string) --
  
  A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

Exceptions

PinpointEmail.Client.exceptions.TooManyRequestsException
PinpointEmail.Client.exceptions.BadRequestException
PinpointEmail.Client.exceptions.NotFoundException

Table Of Contents

list_domain_deliverability_campaigns¶