ReportRequest
import type { ReportRequest } from "https://googleapis.deno.dev/v1/analyticsreporting:v4.ts";
The main request class which specifies the Reporting API request.
§Properties
Cohort group associated with this request. If there is a cohort group in
the request the ga:cohort
dimension must be present. Every
ReportRequest within a batchGet
method must contain the
same cohortGroup
definition.
Date ranges in the request. The request can have a maximum of 2 date
ranges. The response will contain a set of metric values for each
combination of the dimensions for each date range in the request. So, if
there are two date ranges, there will be two set of metric values, one for
the original date range and one for the second date range. The
reportRequest.dateRanges
field should not be specified for cohorts or
Lifetime value requests. If a date range is not provided, the default date
range is (startDate: current date - 7 days, endDate: current date - 1 day).
Every ReportRequest within a batchGet
method must
contain the same dateRanges
definition.
The dimension filter clauses for filtering Dimension Values. They are
logically combined with the AND
operator. Note that filtering occurs
before any dimensions are aggregated, so that the returned metrics
represent the total for only the relevant dimensions.
Dimension or metric filters that restrict the data returned for your
request. To use the filtersExpression
, supply a dimension or metric on
which to filter, followed by the filter expression. For example, the
following expression selects ga:browser
dimension which starts with
Firefox; ga:browser=~^Firefox
. For more information on dimensions and
metric filters, see Filters
reference.
If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
The metric filter clauses. They are logically combined with the AND
operator. Metric filters look at only the first date range and not the
comparing date range. Note that filtering on metrics occurs after the
metrics are aggregated.
Page size is for paging and specifies the maximum number of returned rows.
Page size should be >= 0. A query returns the default of 1,000 rows. The
Analytics Core Reporting API returns a maximum of 100,000 rows per request,
no matter how many you ask for. It can also return fewer rows than
requested, if there aren't as many dimension segments as you expect. For
instance, there are fewer than 300 possible values for ga:country
, so
when segmenting only by country, you can't get more than 300 rows, even if
you set pageSize
to a higher value.
A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
The desired report
sample size. If the
the samplingLevel
field is unspecified the DEFAULT
sampling level is
used. Every ReportRequest within a batchGet
method must
contain the same samplingLevel
definition. See developer
guide for details.
Segment the data returned for the request. A segment definition helps look
at a subset of the segment request. A request can contain up to four
segments. Every ReportRequest within a batchGet
method
must contain the same segments
definition. Requests with segments must
have the ga:segment
dimension.
The Analytics view
ID from which to
retrieve data. Every ReportRequest within a batchGet
method must contain the same viewId
.