MetricMetadata

    • Metric metadata describes a metric using various fields like API name, UI name, description, type, expression, custom definition, blocked reasons, and category.

    • Metrics can have deprecated API names which are still usable for a limited time.

    • Access to a metric can be blocked for specific reasons, such as no access to revenue or cost related metrics, and blocked metrics will return only zeros in reports.

    Explains a metric.

    JSON representation 
     { 
 "apiName" 
 : 
 string 
 , 
 "uiName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "deprecatedApiNames" 
 : 
 [ 
 string 
 ] 
 , 
 "type" 
 : 
 enum (  MetricType 
 
) 
 , 
 "expression" 
 : 
 string 
 , 
 "customDefinition" 
 : 
 boolean 
 , 
 "blockedReasons" 
 : 
 [ 
 enum (  BlockedReason 
 
) 
 ] 
 , 
 "category" 
 : 
 string 
 }
    Fields
    api Name

    string

    A metric name. Useable in Metric 's name . For example, eventCount .
    ui Name

    string

    This metric's name within the Google Analytics user interface. For example, Event count .
    description

    string

    Description of how this metric is used and calculated.
    deprecated Api Names[]

    string

    Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName .
    type

    enum ( MetricType )

    The type of this metric.
    expression

    string

    The mathematical expression for this derived metric. Can be used in Metric 's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.
    custom Definition

    boolean

    True if the metric is a custom metric for this property.
    blocked Reasons[]

    enum ( BlockedReason )

    If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

    To learn more, see Access and data-restriction management .
    category

    string

    The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

    BlockedReason

    Justifications for why this metric is blocked.

    Enums
    BLOCKED_REASON_UNSPECIFIED Will never be specified in API response.
    NO_REVENUE_METRICS If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related.
    NO_COST_METRICS If present, your access is blocked to cost related metrics for this property, and this metric is cost related.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: