BatchGetMetricDataQuery
Represents a single metric data query to include in a batch.
Contents
- EndDate
-
Represents the end date for the query interval.
Type: Timestamp
Required: Yes
- Id
-
The query identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Metric
-
The queried metric. This can be one of the following:
-
SEND– Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient. -
COMPLAINT– Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient -
PERMANENT_BOUNCE– Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient. -
TRANSIENT_BOUNCE– Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient. -
OPEN– Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient. -
CLICK– Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient. -
DELIVERY– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient. -
DELIVERY_OPEN– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers. -
DELIVERY_CLICK– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers. -
DELIVERY_COMPLAINT– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.
Type: String
Valid Values:
SEND | COMPLAINT | PERMANENT_BOUNCE | TRANSIENT_BOUNCE | OPEN | CLICK | DELIVERY | DELIVERY_OPEN | DELIVERY_CLICK | DELIVERY_COMPLAINTRequired: Yes
-
- Namespace
-
The query namespace - e.g.
VDMType: String
Valid Values:
VDMRequired: Yes
- StartDate
-
Represents the start date for the query interval.
Type: Timestamp
Required: Yes
- Dimensions
-
An object that contains mapping between
MetricDimensionNameandMetricDimensionValueto filter metrics by.Type: String to string map
Map Entries: Maximum number of 3 items.
Valid Keys:
EMAIL_IDENTITY | CONFIGURATION_SET | ISPRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
