MetricDefinition

Defines a specific metric to query, including a user-defined name, the base metric type, and optional filters.

JSON representation
{ "name" : string , "baseMetric" : { object ( `BaseMetric` ) } , "filter" : string }

Fields

Fields
`name`	`string` Required. The user-defined name for this metric. This name will be used as the key for this metric's value in the response.
`baseMetric`	`object ( BaseMetric )` Required. The underlying metric to query.
`filter`	`string` Optional. Optional filters to apply to the metric.

name

string

Required. The user-defined name for this metric. This name will be used as the key for this metric's value in the response.

baseMetric

object ( BaseMetric )

Required. The underlying metric to query.

filter

string

Optional. Optional filters to apply to the metric.

BaseMetric

Specifies the base metric to query, which can be a predefined standard metric or a user-defined custom metric (if supported in the future).

JSON representation
{ // Union field `metric` can be only one of the following: "standardMetric" : enum ( `StandardMetric` ) // End of list of possible types for union field `metric` . }

Fields

Union field metric . The specific metric to query. metric can be only one of the following:

standardMetric

A predefined standard metric.

Enumerates the predefined standard metrics that can be queried.

Enums
`STANDARD_METRIC_UNSPECIFIED`	Unspecified standard metric. This value should not be used directly.
`FEEDBACK_LOOP_ID`	Predefined metric for Feedback Loop (FBL) id.
`FEEDBACK_LOOP_SPAM_RATE`	Predefined metric for Feedback Loop (FBL) spam rate. Filter must be of type feedbackLoopId = " " where is one valid feedback loop ids.
`SPAM_RATE`	Predefined metric for spam rate.
`AUTH_SUCCESS_RATE`	The success rate of authentication mechanisms (DKIM, SPF, DMARC). Filter must be of type auth_type = " " where is one of: [spf, dkim, dmarc]
`TLS_ENCRYPTION_MESSAGE_COUNT`	The rate of messages that were TLS encrypted in transit Filter must be of type traffic_direction = " " where is one of: [inbound, outbound]
`TLS_ENCRYPTION_RATE`	The rate of messages that were TLS encrypted in transit Filter must be of type traffic_direction = " " where is one of: [inbound, outbound]
`DELIVERY_ERROR_COUNT`	The total count of delivery errors encountered (temporary or permanent rejects).
`DELIVERY_ERROR_RATE`	Delivery error rate for the specified delivery error type.