domain_statistics_reports
Creates, updates, deletes, gets or lists a domain_statistics_reports resource.
Overview
| Name | domain_statistics_reports |
| Type | Resource |
| Id | aws.sesv2.domain_statistics_reports |
Fields
The following fields are returned by SELECT queries:
- get_domain_statistics_report
| Name | Datatype | Description |
|---|---|---|
daily_volumes | array | 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. |
overall_volume | object | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_domain_statistics_report | select | domain, StartDate, EndDate, region | Retrieve inbox placement and engagement rates for the domains that you use to send email. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
EndDate | string (date-time) | 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. |
StartDate | string (date-time) | The first day (in Unix time) that you want to obtain domain deliverability metrics for. |
domain | string | The domain that you want to obtain deliverability metrics for. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_domain_statistics_report
Retrieve inbox placement and engagement rates for the domains that you use to send email.
SELECT
daily_volumes,
overall_volume
FROM aws.sesv2.domain_statistics_reports
WHERE domain = '{{ domain }}' -- required
AND StartDate = '{{ StartDate }}' -- required
AND EndDate = '{{ EndDate }}' -- required
AND region = '{{ region }}' -- required
;