Skip to main content

ISESV2BatchGetMetricDataQuery

Interface in AWS.SESV2

Interface for SESV2 BatchGetMetricDataQuery.

Properties​

Dimensions​

property Dimensions: TDictionary<string, string>

Optional dimension filters to apply to the metric query.

Filters metrics by specific characteristics of your email sending activity. Each dimension maps a dimension name to a single filter value. When not specified, metrics are aggregated across all dimension values. Supported dimension types include:

  • EMAIL_IDENTITY – Filter by a specific email identity used when sending messages.
  • CONFIGURATION_SET – Filter by a specific configuration set used when sending messages.
  • ISP – Filter by a specific recipient ISP (e.g., gmail.com, yahoo.com). Use * as the dimension value to include all values for that dimension. Maximum of 3 dimension entries are allowed per query.

EndDate​

property EndDate: TDateTime

The end date for the metric query time range.

Represents the end of the time period for which to retrieve metric data. Must be greater than or equal to the StartDate value. The time range defined by StartDate and EndDate is inclusive of both boundary dates for metric data collection.

Id​

property Id: string

A unique identifier for this metric query within the batch request.

This identifier is used to correlate the query with its corresponding result in the response. The Id must be unique within a single BatchGetMetricData request and can be used to reference this query's data in mathematical expressions. Valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. Maximum length is 255 characters.

Metric​

property Metric: string

The metric type to retrieve from the VDM dashboard.

Supported metric types include:

  • SEND – Emails sent eligible for tracking in the VDM dashboard.
  • DELIVERY – Successful deliveries for email sending attempts.
  • OPEN – Unique open events for emails including open trackers.
  • CLICK – Unique click events for emails including wrapped links.
  • COMPLAINT – Complaints received for your account.
  • PERMANENT_BOUNCE – Permanent bounces from non-existent mailboxes.
  • TRANSIENT_BOUNCE – Transient bounces from temporary delivery failures.
  • DELIVERY_OPEN – Successful deliveries with open tracking enabled.
  • DELIVERY_CLICK – Successful deliveries with click tracking enabled.
  • DELIVERY_COMPLAINT – Successful deliveries that resulted in complaints. All metrics exclude emails sent to the mailbox simulator and emails addressed to more than one recipient.

Namespace​

property Namespace: string

The namespace for the metric query.

For Amazon SES Virtual Deliverability Manager (VDM) metrics, this value is always VDM. This namespace categorizes the metrics and ensures they are retrieved from the correct metric collection.

StartDate​

property StartDate: TDateTime

The start date for the metric query time range.

Represents the beginning of the time period for which to retrieve metric data. The date range should not exceed the retention period for VDM metrics. When used with EndDate, defines the inclusive time window for metric data aggregation.

Methods​

AddDimension​

procedure AddDimension(const AName, AValue: string);

Add a dimension to Dimensions.

Parameters

NameDescription
ANameSpecify the name of the dimension to add to Dimensions. Valid values:,, and.
AValueSpecify the value for the dimension to add to Dimensions.