ISESV2MetricsDataSource
Interface in AWS.SESV2
Interface for SESV2 MetricsDataSource.
Properties
Dimensions
property Dimensions: TDictionary<string, TList<string>>
The dimensions to group the metrics by.
A dictionary of dimension names and their values used to group and filter the metrics data. Each dimension allows you to segment metrics by specific attributes of your email sending. Valid dimension keys:
EMAIL_IDENTITY– Groups metrics by the verified email identity used to send messages.CONFIGURATION_SET– Groups metrics by the configuration set associated with the messages.ISP– Groups metrics by the recipient's Internet Service Provider. For each dimension key, you can specify multiple values to include in the export. For example, you might specify multiple configuration set names or ISPs to compare their metrics side by side.
EndDate
property EndDate: TDateTime
The end date and time for the metrics export interval as a timestamp.
The end date is inclusive. Only metrics data up to and including this timestamp will be included in the export. The timestamp includes both date and time components.
Metrics
property Metrics: TList<ISESV2ExportMetric>
Type: ISESV2ExportMetric
The specific metrics to include in the export.
An array of metric definitions specifying which metrics to export and how they should be aggregated. Each metric can be exported as either volume counts or rates.
Namespace
property Namespace: string
The namespace for the metrics to be exported.
Specifies the metric namespace that contains the data to export. This determines the category of metrics available for export. Supported namespace:
VDM– Virtual Deliverability Manager metrics namespace.
StartDate
property StartDate: TDateTime
The start date and time for the metrics export interval as a timestamp.
The start date is inclusive. Only metrics data from this timestamp onwards will be included in the export. The timestamp includes both date and time components.
Methods
AddDimension
procedure AddDimension(const AName, AValue: string); overload;
Add a dimension value to Dimensions.
Parameters
| Name | Description |
|---|---|
AName | Specify the name of the dimension to add. Valid values:,, and. |
AValue | Specify the value to add to the dimension. |
procedure AddDimension(const AName: string; const AValues: TArray<string>); overload;
Add a list of dimension values to Dimensions.
Parameters
| Name | Description |
|---|---|
AName | Specify the name of the dimension to add. Valid values:,, and. |
AValue | Specify a list of values to add to the dimension. |
AddMetric
function AddMetric(const AMetric: ISESV2ExportMetric): NativeInt; overload;
Add a metric to Metrics.
Parameters
| Name | Description |
|---|---|
AMetric | Specify a metric to add to Metrics. |
Returns
Returns the index of the metric added to Metrics.
function AddMetric(const AName, AAggregation: string): NativeInt; overload;
Add a metric to Metrics.
Parameters
| Name | Description |
|---|---|
AName | Specify the name of the metric to add to Metrics. Valid values:,,,,,,,,, and. |
AAggregation | Specify the aggregation method to apply to the metric added to Metrics. Valid values:, and. |
Returns
Returns the index of the metric added to Metrics.