View Source GoogleApi.AnalyticsData.V1beta.Model.RunReportRequest (google_api_analytics_data v0.14.0)
The request to generate a report.
Attributes
-
cohortSpec
(type:GoogleApi.AnalyticsData.V1beta.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 property's default currency. -
dateRanges
(type:list(GoogleApi.AnalyticsData.V1beta.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, thisdateRanges
must be unspecified. -
dimensionFilter
(type:GoogleApi.AnalyticsData.V1beta.Model.FilterExpression.t
, default:nil
) - Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter. -
dimensions
(type:list(GoogleApi.AnalyticsData.V1beta.Model.Dimension.t)
, default:nil
) - The dimensions requested and displayed. -
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. Regardless of thiskeep_empty_rows
setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs apurchase
event, then a query for theeventName
dimension andeventCount
metric will not have a row eventName: "purchase" and eventCount: 0. -
limit
(type:String.t
, default:nil
) - The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for.limit
must be positive. The API can also return fewer rows than the requestedlimit
, if there aren't as many dimension values as thelimit
. For instance, there are fewer than 300 possible values for the dimensioncountry
, so when reporting on onlycountry
, you can't get more than 300 rows, even if you setlimit
to a higher value. 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.V1beta.Model.FilterExpression.t
, default:nil
) - The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. -
metrics
(type:list(GoogleApi.AnalyticsData.V1beta.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. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the firstlimit
of rows. The second request sets offset to thelimit
of the first request; the second request returns the secondlimit
of rows. To learn more about this pagination parameter, see Pagination. -
orderBys
(type:list(GoogleApi.AnalyticsData.V1beta.Model.OrderBy.t)
, default:nil
) - Specifies how rows are ordered in the response. -
property
(type:String.t
, default:nil
) - 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234 -
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.V1beta.Model.RunReportRequest{ cohortSpec: GoogleApi.AnalyticsData.V1beta.Model.CohortSpec.t() | nil, currencyCode: String.t() | nil, dateRanges: [GoogleApi.AnalyticsData.V1beta.Model.DateRange.t()] | nil, dimensionFilter: GoogleApi.AnalyticsData.V1beta.Model.FilterExpression.t() | nil, dimensions: [GoogleApi.AnalyticsData.V1beta.Model.Dimension.t()] | nil, keepEmptyRows: boolean() | nil, limit: String.t() | nil, metricAggregations: [String.t()] | nil, metricFilter: GoogleApi.AnalyticsData.V1beta.Model.FilterExpression.t() | nil, metrics: [GoogleApi.AnalyticsData.V1beta.Model.Metric.t()] | nil, offset: String.t() | nil, orderBys: [GoogleApi.AnalyticsData.V1beta.Model.OrderBy.t()] | nil, property: String.t() | nil, returnPropertyQuota: boolean() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.