List Domain Deliverability Campaigns

pinpointemail_list_domain_deliverability_campaigns

R Documentation

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range

Description

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 (put_deliverability_dashboard_option operation) for the domain.

Usage

pinpointemail_list_domain_deliverability_campaigns(StartDate, EndDate,
  SubscribedDomain, NextToken, PageSize)

Arguments

StartDate

[required] The first day, in Unix time format, that you want to obtain deliverability data for.

EndDate

[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

[required] The domain to obtain deliverability data for.

NextToken

A token that’s returned from a previous call to the list_domain_deliverability_campaigns operation. This token indicates the position of a campaign in the list of campaigns.

PageSize

The maximum number of results to include in response to a single call to the list_domain_deliverability_campaigns 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.

Value

A list with the following syntax:

list(
  DomainDeliverabilityCampaigns = list(
    list(
      CampaignId = "string",
      ImageUrl = "string",
      Subject = "string",
      FromAddress = "string",
      SendingIps = list(
        "string"
      ),
      FirstSeenDateTime = as.POSIXct(
        "2015-01-01"
      ),
      LastSeenDateTime = as.POSIXct(
        "2015-01-01"
      ),
      InboxCount = 123,
      SpamCount = 123,
      ReadRate = 123.0,
      DeleteRate = 123.0,
      ReadDeleteRate = 123.0,
      ProjectedVolume = 123,
      Esps = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_domain_deliverability_campaigns(
  StartDate = as.POSIXct(
    "2015-01-01"
  ),
  EndDate = as.POSIXct(
    "2015-01-01"
  ),
  SubscribedDomain = "string",
  NextToken = "string",
  PageSize = 123
)