Get Domain Statistics Report

pinpointemail_get_domain_statistics_report

R Documentation

Retrieve inbox placement and engagement rates for the domains that you use to send email

Description

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Usage

pinpointemail_get_domain_statistics_report(Domain, StartDate, EndDate)

Arguments

Domain

[required] The domain that you want to obtain deliverability metrics for.

StartDate

[required] The first day (in Unix time) that you want to obtain domain deliverability metrics for.

EndDate

[required] The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

Value

A list with the following syntax:

list(
  OverallVolume = list(
    VolumeStatistics = list(
      InboxRawCount = 123,
      SpamRawCount = 123,
      ProjectedInbox = 123,
      ProjectedSpam = 123
    ),
    ReadRatePercent = 123.0,
    DomainIspPlacements = list(
      list(
        IspName = "string",
        InboxRawCount = 123,
        SpamRawCount = 123,
        InboxPercentage = 123.0,
        SpamPercentage = 123.0
      )
    )
  ),
  DailyVolumes = list(
    list(
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      VolumeStatistics = list(
        InboxRawCount = 123,
        SpamRawCount = 123,
        ProjectedInbox = 123,
        ProjectedSpam = 123
      ),
      DomainIspPlacements = list(
        list(
          IspName = "string",
          InboxRawCount = 123,
          SpamRawCount = 123,
          InboxPercentage = 123.0,
          SpamPercentage = 123.0
        )
      )
    )
  )
)

Request syntax

svc$get_domain_statistics_report(
  Domain = "string",
  StartDate = as.POSIXct(
    "2015-01-01"
  ),
  EndDate = as.POSIXct(
    "2015-01-01"
  )
)