GoogleApi.AnalyticsData.V1alpha.Model.RunReportRequest (google_api_analytics_data v0.10.1) View Source

The request to generate a report.

Attributes

  • cohortSpec (type: GoogleApi.AnalyticsData.V1alpha.Model.CohortSpec.t, default: nil) - Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
  • currencyCode (type: String.t, default: nil) - A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.
  • dateRanges (type: list(GoogleApi.AnalyticsData.V1alpha.Model.DateRange.t), default: nil) - Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this dateRanges must be unspecified.
  • 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.
  • entity (type: GoogleApi.AnalyticsData.V1alpha.Model.Entity.t, default: nil) - A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.
  • keepEmptyRows (type: boolean(), default: nil) - If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
  • 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. To learn more about this pagination parameter, see Pagination.
  • 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.
  • offset (type: String.t, default: nil) - The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see Pagination.
  • 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 quota. Quota is returned in PropertyQuota.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.AnalyticsData.V1alpha.Model.RunReportRequest{
  cohortSpec: GoogleApi.AnalyticsData.V1alpha.Model.CohortSpec.t() | nil,
  currencyCode: String.t() | nil,
  dateRanges: [GoogleApi.AnalyticsData.V1alpha.Model.DateRange.t()] | nil,
  dimensionFilter:
    GoogleApi.AnalyticsData.V1alpha.Model.FilterExpression.t() | nil,
  dimensions: [GoogleApi.AnalyticsData.V1alpha.Model.Dimension.t()] | nil,
  entity: GoogleApi.AnalyticsData.V1alpha.Model.Entity.t() | nil,
  keepEmptyRows: boolean() | 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,
  offset: String.t() | nil,
  orderBys: [GoogleApi.AnalyticsData.V1alpha.Model.OrderBy.t()] | nil,
  returnPropertyQuota: boolean() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.