Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see Creating a Report.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/analytics.readonly

If unset, the scope for this method defaults to https://www.googleapis.com/auth/analytics. You can set the scope for this method like this: analyticsdata1-beta --scope <scope> properties run-report ...

Required Scalar Argument

  • <property> (string)
    • A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

RunReportRequest:
  cohort-spec:
    cohort-report-settings:
      accumulate: boolean
    cohorts-range:
      end-offset: integer
      granularity: string
      start-offset: integer
  currency-code: string
  dimension-filter:
    filter:
      between-filter:
        from-value:
          double-value: number
          int64-value: string
        to-value:
          double-value: number
          int64-value: string
      field-name: string
      in-list-filter:
        case-sensitive: boolean
        values: [string]
      numeric-filter:
        operation: string
        value:
          double-value: number
          int64-value: string
      string-filter:
        case-sensitive: boolean
        match-type: string
        value: string
  keep-empty-rows: boolean
  limit: string
  metric-aggregations: [string]
  metric-filter:
    filter:
      between-filter:
        from-value:
          double-value: number
          int64-value: string
        to-value:
          double-value: number
          int64-value: string
      field-name: string
      in-list-filter:
        case-sensitive: boolean
        values: [string]
      numeric-filter:
        operation: string
        value:
          double-value: number
          int64-value: string
      string-filter:
        case-sensitive: boolean
        match-type: string
        value: string
  offset: string
  property: string
  return-property-quota: boolean

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .cohort-spec.cohort-report-settings accumulate=true

    • If true, accumulates the result from first touch day to the end day. Not supported in RunReportRequest.

  • ..cohorts-range end-offset=69

    • Required. endOffset specifies the end date of the extended reporting date range for a cohort report. endOffset can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If granularity is DAILY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset days. If granularity is WEEKLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 7 days. If granularity is MONTHLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 30 days.
  • granularity=dolores
    • Required. The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report.

  • start-offset=6

    • startOffset specifies the start date of the extended reporting date range for a cohort report. startOffset is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If granularity is DAILY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset days. If granularity is WEEKLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 7 days. If granularity is MONTHLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 30 days.

  • ... currency-code=erat

    • A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.
  • dimension-filter.filter.between-filter.from-value double-value=0.14995920976292842
    • Double value

  • int64-value=est

    • Integer value

  • ..to-value double-value=0.6063928061497748

    • Double value

  • int64-value=consetetur

    • Integer value

  • ... field-name=consetetur

    • The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.
  • in-list-filter case-sensitive=true
    • If true, the string value is case sensitive.

  • values=est

    • The list of string values. Must be non-empty.
    • Each invocation of this argument appends the given value to the array.

  • ..numeric-filter operation=aliquyam

    • The operation type for this filter.
  • value double-value=0.05595565314531503
    • Double value

  • int64-value=diam

    • Integer value

  • ...string-filter case-sensitive=true

    • If true, the string value is case sensitive.
  • match-type=sit
    • The match type for this filter.

  • value=sed

    • The string value used for the matching.

  • .... keep-empty-rows=false

    • If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.
  • limit=lorem
    • The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive. The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination.
  • metric-aggregations=ea
    • Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
    • Each invocation of this argument appends the given value to the array.
  • metric-filter.filter.between-filter.from-value double-value=0.6768631685059072
    • Double value

  • int64-value=eos

    • Integer value

  • ..to-value double-value=0.26366414664221993

    • Double value

  • int64-value=et

    • Integer value

  • ... field-name=at

    • The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.
  • in-list-filter case-sensitive=false
    • If true, the string value is case sensitive.

  • values=eirmod

    • The list of string values. Must be non-empty.
    • Each invocation of this argument appends the given value to the array.

  • ..numeric-filter operation=lorem

    • The operation type for this filter.
  • value double-value=0.6131721394478933
    • Double value

  • int64-value=erat

    • Integer value

  • ...string-filter case-sensitive=true

    • If true, the string value is case sensitive.
  • match-type=erat
    • The match type for this filter.

  • value=accusam

    • The string value used for the matching.

  • .... offset=sea

    • The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows. To learn more about this pagination parameter, see Pagination.
  • property=takimata
    • A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234
  • return-property-quota=true
    • Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").