runRealtimeReport method

Future<RunRealtimeReportResponse> runRealtimeReport(
  1. RunRealtimeReportRequest request,
  2. String property, {
  3. String? $fields,
})

The Google Analytics Realtime API returns a customized report of realtime event data for your property.

These reports show events and usage from the last 30 minutes.

request - The metadata request object.

Request parameters:

property - 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. Example: properties/1234 Value must have pattern ^properties/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a RunRealtimeReportResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<RunRealtimeReportResponse> runRealtimeReport(
  RunRealtimeReportRequest request,
  core.String property, {
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request);
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final _url =
      'v1beta/' + core.Uri.encodeFull('$property') + ':runRealtimeReport';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return RunRealtimeReportResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}