View Source GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportRequest (google_api_analytics_data v0.14.0)
The request to generate a pivot 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
) - The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, thisdateRanges
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. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. -
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. -
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, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys. -
pivots
(type:list(GoogleApi.AnalyticsData.V1alpha.Model.Pivot.t)
, default:nil
) - Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot. -
returnPropertyQuota
(type:boolean()
, default:nil
) - Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportRequest{ 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, metricFilter: GoogleApi.AnalyticsData.V1alpha.Model.FilterExpression.t() | nil, metrics: [GoogleApi.AnalyticsData.V1alpha.Model.Metric.t()] | nil, pivots: [GoogleApi.AnalyticsData.V1alpha.Model.Pivot.t()] | nil, returnPropertyQuota: boolean() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.