[ aws . sesv2 ]

get-domain-statistics-report

Description

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

See also: AWS API Documentation

Synopsis

  get-domain-statistics-report
--domain <value>
--start-date <value>
--end-date <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--domain (string)

The domain that you want to obtain deliverability metrics for.

--start-date (timestamp)

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

--end-date (timestamp)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

OverallVolume -> (structure)

An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate .

VolumeStatistics -> (structure)

An object that contains information about the numbers of messages that arrived in recipients’ inboxes and junk mail folders.

InboxRawCount -> (long)

The total number of emails that arrived in recipients’ inboxes.

SpamRawCount -> (long)

The total number of emails that arrived in recipients’ spam or junk mail folders.

ProjectedInbox -> (long)

An estimate of the percentage of emails sent from the current domain that will arrive in recipients’ inboxes.

ProjectedSpam -> (long)

An estimate of the percentage of emails sent from the current domain that will arrive in recipients’ spam or junk mail folders.

ReadRatePercent -> (double)

The percentage of emails that were sent from the domain that were read by their recipients.

DomainIspPlacements -> (list)

An object that contains inbox and junk mail placement metrics for individual email providers.

(structure)

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

IspName -> (string)

The name of the email provider that the inbox placement data applies to.

InboxRawCount -> (long)

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ inboxes.

SpamRawCount -> (long)

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ spam or junk mail folders.

InboxPercentage -> (double)

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ inboxes.

SpamPercentage -> (double)

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ spam or junk mail folders.

DailyVolumes -> (list)

An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate .

(structure)

An object that contains information about the volume of email sent on each day of the analysis period.

StartDate -> (timestamp)

The date that the DailyVolume metrics apply to, in Unix time.

VolumeStatistics -> (structure)

An object that contains inbox placement metrics for a specific day in the analysis period.

InboxRawCount -> (long)

The total number of emails that arrived in recipients’ inboxes.

SpamRawCount -> (long)

The total number of emails that arrived in recipients’ spam or junk mail folders.

ProjectedInbox -> (long)

An estimate of the percentage of emails sent from the current domain that will arrive in recipients’ inboxes.

ProjectedSpam -> (long)

An estimate of the percentage of emails sent from the current domain that will arrive in recipients’ spam or junk mail folders.

DomainIspPlacements -> (list)

An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient’s email provider.

(structure)

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

IspName -> (string)

The name of the email provider that the inbox placement data applies to.

InboxRawCount -> (long)

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ inboxes.

SpamRawCount -> (long)

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ spam or junk mail folders.

InboxPercentage -> (double)

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ inboxes.

SpamPercentage -> (double)

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients’ spam or junk mail folders.