ResponseMetaData

    • Response metadata provides additional information about a report, including potential data loss, sampling details, schema restrictions, currency, timezone, and reasons for an empty report.

    • SchemaRestrictionResponse details the specific schema restrictions applied when generating a report, such as active metric restrictions.

    • ActiveMetricRestriction identifies metrics that are restricted in the report and the reasons for their restriction, like cost or revenue data.

    • RestrictedMetricType specifies categories of data that may have viewing restrictions in Google Analytics.

    • SamplingMetadata describes the sampling rate if a report is sampled, including the number of events read and the total sampling space size.

    Response's metadata carrying additional information about the report content.

    JSON representation 
     { 
 "dataLossFromOtherRow" 
 : 
 boolean 
 , 
 "samplingMetadatas" 
 : 
 [ 
 { 
 object (  SamplingMetadata 
 
) 
 } 
 ] 
 , 
 "schemaRestrictionResponse" 
 : 
 { 
 object (  SchemaRestrictionResponse 
 
) 
 } 
 , 
 "currencyCode" 
 : 
 string 
 , 
 "timeZone" 
 : 
 string 
 , 
 "emptyReason" 
 : 
 string 
 , 
 "subjectToThresholding" 
 : 
 boolean 
 }
    Fields
    data Loss From Other Row

    boolean

    If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

    The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

    For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

    To learn more, see About the (other) row and data sampling .
    sampling Metadatas[]

    object ( SamplingMetadata )

    If this report results is sampled , this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

    However if the results are not sampled, this field will not be defined.
    schema Restriction Response

    object ( SchemaRestrictionResponse )

    Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management .
    currency Code

    string

    The currency code used in this report. Intended to be used in formatting currency metrics like purchaseRevenue for visualization. If currencyCode was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currencyCode.

    Currency codes are string encodings of currency types from the ISO 4217 standard ( https://en.wikipedia.org/wiki/ISO_4217) ; for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179 .
    time Zone

    string

    The property's current timezone. Intended to be used to interpret time-based dimensions like hour and minute . Formatted as strings from the IANA Time Zone database ( https://www.iana.org/time-zones) ; for example "America/New_York" or "Asia/Tokyo".
    empty Reason

    string

    If empty reason is specified, the report is empty for this reason.
    subject To Thresholding

    boolean

    If subjectToThresholding is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see Data thresholds .

    SchemaRestrictionResponse

    The schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management .

    JSON representation 
     { 
 "activeMetricRestrictions" 
 : 
 [ 
 { 
 object (  ActiveMetricRestriction 
 
) 
 } 
 ] 
 }
    Fields
    active Metric Restrictions[]

    object ( ActiveMetricRestriction )

    All restrictions actively enforced in creating the report. For example, purchaseRevenue always has the restriction type REVENUE_DATA . However, this active response restriction is only populated if the user's custom role disallows access to REVENUE_DATA .

    ActiveMetricRestriction

    A metric actively restricted in creating the report.

    JSON representation 
     { 
 "restrictedMetricTypes" 
 : 
 [ 
 enum (  RestrictedMetricType 
 
) 
 ] 
 , 
 "metricName" 
 : 
 string 
 }
    Fields
    restricted Metric Types[]

    enum ( RestrictedMetricType )

    The reason for this metric's restriction.
    metric Name

    string

    The name of the restricted metric.

    RestrictedMetricType

    Categories of data that you may be restricted from viewing on certain Google Analytics properties.

    Enums
    RESTRICTED_METRIC_TYPE_UNSPECIFIED Unspecified type.
    COST_DATA Cost metrics such as adCost .
    REVENUE_DATA Revenue metrics such as purchaseRevenue .

    SamplingMetadata

    If this report results is sampled , this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.

    JSON representation 
     { 
 "samplesReadCount" 
 : 
 string 
 , 
 "samplingSpaceSize" 
 : 
 string 
 }
    Fields
    samples Read Count

    string ( int64 format)

    The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this report.
    sampling Space Size

    string ( int64 format)

    The total number of events present in this property's data that could have been analyzed in this report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set.

    To calculate the percentage of available data that was used in this report, compute samplesReadCount/samplingSpaceSize .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: