GoogleApi.AnalyticsData.V1alpha.Api.Properties.analyticsdata_properties_run_realtime_report

You're seeing just the function analyticsdata_properties_run_realtime_report, go back to GoogleApi.AnalyticsData.V1alpha.Api.Properties module for more information.
Link to this function

analyticsdata_properties_run_realtime_report(connection, property, optional_params \\ [], opts \\ [])

View Source

Specs

analyticsdata_properties_run_realtime_report(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AnalyticsData.V1alpha.Model.RunRealtimeReportResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.AnalyticsData.V1alpha.Connection.t) - Connection to server
  • property (type: String.t) - 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
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AnalyticsData.V1alpha.Model.RunRealtimeReportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AnalyticsData.V1alpha.Model.RunRealtimeReportResponse{}} on success
  • {:error, info} on failure