Reference documentation and code samples for the Google Analytics Data V1beta Client class RunRealtimeReportRequest.
The request to generate a realtime report.
Generated from protobuf messagegoogle.analytics.data.v1beta.RunRealtimeReportRequest
Namespace
Google \ Analytics \ Data \ V1beta
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ property
string
A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, seewhere to find your Property ID. Example: properties/1234
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.
↳ limit
int|string
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.limitmust be positive. The API can also return fewer rows than the requestedlimit, if there aren't as many dimension values as thelimit. For instance, there are fewer than 300 possible values for the dimensioncountry, so when reporting on onlycountry, you can't get more than 300 rows, even if you setlimitto a higher value.
↳ metric_aggregations
array
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
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.
getProperty
A Google Analytics property identifier whose events are tracked.
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.limitmust be positive.
The API can also return fewer rows than the requestedlimit, if there
aren't as many dimension values as thelimit. For instance, there are
fewer than 300 possible values for the dimensioncountry, so when
reporting on onlycountry, you can't get more than 300 rows, even if you
setlimitto a higher value.
Returns
Type
Description
int|string
setLimit
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.limitmust be positive.
The API can also return fewer rows than the requestedlimit, if there
aren't as many dimension values as thelimit. For instance, there are
fewer than 300 possible values for the dimensioncountry, so when
reporting on onlycountry, you can't get more than 300 rows, even if you
setlimitto a higher value.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows
where the dimension_values are set to "RESERVED_(MetricAggregation)".
Toggles whether to return the current state of this Google Analytics
property's Realtime quota. Quota is returned inPropertyQuota.
Returns
Type
Description
bool
setReturnPropertyQuota
Toggles whether to return the current state of this Google Analytics
property's Realtime quota. Quota is returned inPropertyQuota.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getMinuteRanges
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Data V1beta Client - Class RunRealtimeReportRequest (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1beta.RunRealtimeReportRequest)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1beta.RunRealtimeReportRequest)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1beta.RunRealtimeReportRequest)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1beta.RunRealtimeReportRequest)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1beta.RunRealtimeReportRequest)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1beta.RunRealtimeReportRequest)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1beta.RunRealtimeReportRequest)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1beta.RunRealtimeReportRequest)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1beta.RunRealtimeReportRequest)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1beta.RunRealtimeReportRequest)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1beta.RunRealtimeReportRequest)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1beta.RunRealtimeReportRequest)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1beta.RunRealtimeReportRequest)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1beta.RunRealtimeReportRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1beta Client class RunRealtimeReportRequest.\n\nThe request to generate a realtime report.\n\nGenerated from protobuf message `google.analytics.data.v1beta.RunRealtimeReportRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProperty\n\nA Google Analytics property identifier whose events are tracked.\n\nSpecified in the URL path and not the body. To learn more, see [where to\nfind your Property\nID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).\nExample: properties/1234\n\n### setProperty\n\nA Google Analytics property identifier whose events are tracked.\n\nSpecified in the URL path and not the body. To learn more, see [where to\nfind your Property\nID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).\nExample: properties/1234\n\n### getDimensions\n\nThe dimensions requested and displayed.\n\n### setDimensions\n\nThe dimensions requested and displayed.\n\n### getMetrics\n\nThe metrics requested and displayed.\n\n### setMetrics\n\nThe metrics requested and displayed.\n\n### getDimensionFilter\n\nThe filter clause of dimensions. Metrics cannot be used in this filter.\n\n### hasDimensionFilter\n\n### clearDimensionFilter\n\n### setDimensionFilter\n\nThe filter clause of dimensions. Metrics cannot be used in this filter.\n\n### getMetricFilter\n\nThe filter clause of metrics. Applied at post aggregation phase, similar to\nSQL having-clause. Dimensions cannot be used in this filter.\n\n### hasMetricFilter\n\n### clearMetricFilter\n\n### setMetricFilter\n\nThe filter clause of metrics. Applied at post aggregation phase, similar to\nSQL having-clause. Dimensions cannot be used in this filter.\n\n### getLimit\n\nThe number of rows to return. If unspecified, 10,000 rows are returned. The\nAPI returns a maximum of 250,000 rows per request, no matter how many you\nask for. `limit` must be positive.\n\nThe API can also return fewer rows than the requested `limit`, if there\naren't as many dimension values as the `limit`. For instance, there are\nfewer than 300 possible values for the dimension `country`, so when\nreporting on only `country`, you can't get more than 300 rows, even if you\nset `limit` to a higher value.\n\n### setLimit\n\nThe number of rows to return. If unspecified, 10,000 rows are returned. The\nAPI returns a maximum of 250,000 rows per request, no matter how many you\nask for. `limit` must be positive.\n\nThe API can also return fewer rows than the requested `limit`, if there\naren't as many dimension values as the `limit`. For instance, there are\nfewer than 300 possible values for the dimension `country`, so when\nreporting on only `country`, you can't get more than 300 rows, even if you\nset `limit` to a higher value.\n\n### getMetricAggregations\n\nAggregation of metrics. Aggregated metric values will be shown in rows\nwhere the dimension_values are set to \"RESERVED_(MetricAggregation)\".\n\n### setMetricAggregations\n\nAggregation of metrics. Aggregated metric values will be shown in rows\nwhere the dimension_values are set to \"RESERVED_(MetricAggregation)\".\n\n### getOrderBys\n\nSpecifies how rows are ordered in the response.\n\n### setOrderBys\n\nSpecifies how rows are ordered in the response.\n\n### getReturnPropertyQuota\n\nToggles whether to return the current state of this Google Analytics\nproperty's Realtime quota. Quota is returned in\n[PropertyQuota](#PropertyQuota).\n\n### setReturnPropertyQuota\n\nToggles whether to return the current state of this Google Analytics\nproperty's Realtime quota. Quota is returned in\n[PropertyQuota](#PropertyQuota).\n\n### getMinuteRanges\n\nThe minute ranges of event data to read. If unspecified, one minute range\nfor the last 30 minutes will be used. If multiple minute ranges are\nrequested, each response row will contain a zero based minute range index.\n\nIf two minute ranges overlap, the event data for the overlapping minutes is\nincluded in the response rows for both minute ranges.\n\n### setMinuteRanges\n\nThe minute ranges of event data to read. If unspecified, one minute range\nfor the last 30 minutes will be used. If multiple minute ranges are\nrequested, each response row will contain a zero based minute range index.\n\nIf two minute ranges overlap, the event data for the overlapping minutes is\nincluded in the response rows for both minute ranges."]]
