---
title: "POST /v1beta/{+property}:runRealtimeReport"
method: POST
path: "/v1beta/{+property}:runRealtimeReport"
tags: ["properties"]
---

# POST /v1beta/{+property}:runRealtimeReport

`POST /v1beta/{+property}:runRealtimeReport`

Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).

## Path parameters

- `property` string, required

## Request body

- RunRealtimeReportRequest — The request to generate a realtime report.
  - `metricFilter` FilterExpression — To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
    - `filter` Filter — An expression to filter dimension or metric values.
      - `stringFilter` StringFilter — The filter for string
        - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'EXACT' | 'BEGINS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'FULL_REGEXP' | 'PARTIAL_REGEXP' — The match type for this filter.
        - `value` string — The string value used for the matching.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
      - `inListFilter` InListFilter — The result needs to be in a list of string values.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
        - `values` string[] — The list of string values. Must be non-empty.
      - `fieldName` string — 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.
      - `betweenFilter` BetweenFilter — To express that the result needs to be between two numbers (inclusive).
        - `fromValue` NumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
        - `toValue` NumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
      - `emptyFilter` EmptyFilter — Filter for empty values.
      - `numericFilter` NumericFilter — Filters for numeric or date values.
        - `operation` 'OPERATION_UNSPECIFIED' | 'EQUAL' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' — The operation type for this filter.
        - `value` NumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
    - `andGroup` FilterExpressionList — A list of filter expressions.
      - `expressions` FilterExpression[] — A list of filter expressions.
    - `notExpression` FilterExpression — recursive
    - `orGroup` FilterExpressionList — A list of filter expressions.
      - `expressions` FilterExpression[] — A list of filter expressions.
  - `limit` string, int64 — 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.
  - `returnPropertyQuota` boolean — Toggles whether to return the current state of this Google Analytics property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
  - `dimensions` Dimension[] — The dimensions requested and displayed.
    - `name` string — The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) for the list of dimension names supported by the `runFunnelReport` method. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
    - `dimensionExpression` DimensionExpression — Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).
      - `concatenate` ConcatenateExpression — Used to combine dimension values to a single dimension.
        - `delimiter` string — The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".
        - `dimensionNames` string[] — Names of dimensions. The names must refer back to names in the dimensions field of the request.
      - `lowerCase` CaseExpression — Used to convert a dimension value to a single case.
        - `dimensionName` string — Name of a dimension. The name must refer back to a name in dimensions field of the request.
      - `upperCase` CaseExpression — Used to convert a dimension value to a single case.
        - `dimensionName` string — Name of a dimension. The name must refer back to a name in dimensions field of the request.
  - `dimensionFilter` FilterExpression — To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
    - `filter` Filter — An expression to filter dimension or metric values.
      - `stringFilter` StringFilter — The filter for string
        - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'EXACT' | 'BEGINS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'FULL_REGEXP' | 'PARTIAL_REGEXP' — The match type for this filter.
        - `value` string — The string value used for the matching.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
      - `inListFilter` InListFilter — The result needs to be in a list of string values.
        - `caseSensitive` boolean — If true, the string value is case sensitive.
        - `values` string[] — The list of string values. Must be non-empty.
      - `fieldName` string — 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.
      - `betweenFilter` BetweenFilter — To express that the result needs to be between two numbers (inclusive).
        - `fromValue` NumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
        - `toValue` NumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
      - `emptyFilter` EmptyFilter — Filter for empty values.
      - `numericFilter` NumericFilter — Filters for numeric or date values.
        - `operation` 'OPERATION_UNSPECIFIED' | 'EQUAL' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' — The operation type for this filter.
        - `value` NumericValue — To represent a number.
          - `int64Value` string, int64 — Integer value
          - `doubleValue` number, double — Double value
    - `andGroup` FilterExpressionList — A list of filter expressions.
      - `expressions` FilterExpression[] — A list of filter expressions.
    - `notExpression` FilterExpression — recursive
    - `orGroup` FilterExpressionList — A list of filter expressions.
      - `expressions` FilterExpression[] — A list of filter expressions.
  - `minuteRanges` MinuteRange[] — The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.
    - `startMinutesAgo` integer — The inclusive start minute for the query as a number of minutes before now. For example, `"startMinutesAgo": 29` specifies the report should include event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics properties can request up to the last 30 minutes of event data (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to the last 60 minutes of event data (`startMinutesAgo <= 59`).
    - `endMinutesAgo` integer — The inclusive end minute for the query as a number of minutes before now. Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15` specifies the report should include event data from prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics properties can request any minute in the last 30 minutes of event data (`endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
    - `name` string — Assigns a name to this minute range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, minute ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.
  - `metrics` Metric[] — The metrics requested and displayed.
    - `name` string — The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the list of metric names supported by the `runRealtimeReport` method. See [Funnel Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics) for the list of metric names supported by the `runFunnelReport` method. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.
    - `expression` string — A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.
    - `invisible` boolean — Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.
  - `orderBys` OrderBy[] — Specifies how rows are ordered in the response.
    - `metric` MetricOrderBy — Sorts by metric values.
      - `metricName` string — A metric name in the request to order by.
    - `dimension` DimensionOrderBy — Sorts by dimension values.
      - `dimensionName` string — A dimension name in the request to order by.
      - `orderType` 'ORDER_TYPE_UNSPECIFIED' | 'ALPHANUMERIC' | 'CASE_INSENSITIVE_ALPHANUMERIC' | 'NUMERIC' — Controls the rule for dimension value ordering.
    - `pivot` PivotOrderBy — Sorts by a pivot column group.
      - `pivotSelections` PivotSelection[] — Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.
        - `dimensionName` string — Must be a dimension name from the request.
        - `dimensionValue` string — Order by only when the named dimension is this value.
      - `metricName` string — In the response to order by, order rows by this column. Must be a metric name from the request.
    - `desc` boolean — If true, sorts by descending order.
  - `metricAggregations` string[] — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/analyticsdata.md) · [All operations](https://skmtc.dev/google/apis/analyticsdata/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/analyticsdata/revisions/b348cd401840/schema)