View Source GoogleApi.AnalyticsData.V1alpha.Model.RunRealtimeReportRequest (google_api_analytics_data v0.14.0)

The request to generate a realtime report.

Attributes

  • dimensionFilter (type: GoogleApi.AnalyticsData.V1alpha.Model.FilterExpression.t, default: nil) - The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
  • dimensions (type: list(GoogleApi.AnalyticsData.V1alpha.Model.Dimension.t), default: nil) - The dimensions requested and displayed.
  • limit (type: String.t, default: nil) - The number of rows to return. If the limit parameter is unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for.
  • metricAggregations (type: list(String.t), default: nil) - Aggregation of metrics. Aggregated metric values will be shown in rows where the dimensionvalues are set to "RESERVED(MetricAggregation)".
  • metricFilter (type: GoogleApi.AnalyticsData.V1alpha.Model.FilterExpression.t, default: nil) - The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
  • metrics (type: list(GoogleApi.AnalyticsData.V1alpha.Model.Metric.t), default: nil) - The metrics requested and displayed.
  • orderBys (type: list(GoogleApi.AnalyticsData.V1alpha.Model.OrderBy.t), default: nil) - Specifies how rows are ordered in the response.
  • returnPropertyQuota (type: boolean(), default: nil) - Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.AnalyticsData.V1alpha.Model.RunRealtimeReportRequest{
  dimensionFilter:
    GoogleApi.AnalyticsData.V1alpha.Model.FilterExpression.t() | nil,
  dimensions: [GoogleApi.AnalyticsData.V1alpha.Model.Dimension.t()] | nil,
  limit: String.t() | nil,
  metricAggregations: [String.t()] | nil,
  metricFilter:
    GoogleApi.AnalyticsData.V1alpha.Model.FilterExpression.t() | nil,
  metrics: [GoogleApi.AnalyticsData.V1alpha.Model.Metric.t()] | nil,
  orderBys: [GoogleApi.AnalyticsData.V1alpha.Model.OrderBy.t()] | nil,
  returnPropertyQuota: boolean() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.