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
    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 
     { 
 "standardMetric" 
 : 
 enum (  StandardMetric 
 
) 
 }
    Fields
    Union field metric . The specific metric to query. metric can be only one of the following:
    standardMetric

    enum ( StandardMetric )

    A predefined standard metric.

    StandardMetric

    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 feedback_loop_id = " " 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). The filter field supports a limited syntax. Supported formats are:

    • Empty: No filter is applied.
    • error_type = " "
    • error_type = " " AND error_reason = " "

    If an empty filter is provided, the metric will be aggregated across all error types and reasons. If only error_type is specified, the metric will be aggregated across all reasons for that type.

    Supported values:

    • reject
    • temp_fail

    Supported values depend on the :

    • For 'reject': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
    • For 'temp_fail': [anomalous_traffic_pattern, other]
    DELIVERY_ERROR_RATE

    Delivery error rate for the specified delivery error type. The filter field supports a limited syntax. Supported formats are:

    • Empty: No filter is applied.
    • error_type = " "
    • error_type = " " AND error_reason = " "

    If an empty filter is provided, the metric will be aggregated across all error types and reasons. If only error_type is specified, the metric will be aggregated across all reasons for that type.

    Supported values:

    • reject
    • temp_fail

    Supported values depend on the :

    • For 'reject': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other]
    • For 'temp_fail': [anomalous_traffic_pattern, other]
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: