Class ReportRequest

The main request class which specifies the Reporting API request.

Inheritance
object
ReportRequest
Implements
Inherited Members
Namespace: Google.Apis.AnalyticsReporting.v4.Data
Assembly: Google.Apis.AnalyticsReporting.v4.dll
Syntax
public class ReportRequest : IDirectResponseSchema

Properties

CohortGroup

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.

Declaration
[JsonProperty("cohortGroup")]
public virtual CohortGroup CohortGroup { get; set; }
Property Value
Type Description
CohortGroup

DateRanges

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.

Declaration
[JsonProperty("dateRanges")]
public virtual IList<DateRange> DateRanges { get; set; }
Property Value
Type Description
IList<DateRange>

DimensionFilterClauses

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.

Declaration
[JsonProperty("dimensionFilterClauses")]
public virtual IList<DimensionFilterClause> DimensionFilterClauses { get; set; }
Property Value
Type Description
IList<DimensionFilterClause>

Dimensions

The dimensions requested. Requests can have a total of 9 dimensions.

Declaration
[JsonProperty("dimensions")]
public virtual IList<Dimension> Dimensions { get; set; }
Property Value
Type Description
IList<Dimension>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FiltersExpression

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.

Declaration
[JsonProperty("filtersExpression")]
public virtual string FiltersExpression { get; set; }
Property Value
Type Description
string

HideTotals

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.

Declaration
[JsonProperty("hideTotals")]
public virtual bool? HideTotals { get; set; }
Property Value
Type Description
bool?

HideValueRanges

If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.

Declaration
[JsonProperty("hideValueRanges")]
public virtual bool? HideValueRanges { get; set; }
Property Value
Type Description
bool?

IncludeEmptyRows

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.

Declaration
[JsonProperty("includeEmptyRows")]
public virtual bool? IncludeEmptyRows { get; set; }
Property Value
Type Description
bool?

MetricFilterClauses

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.

Declaration
[JsonProperty("metricFilterClauses")]
public virtual IList<MetricFilterClause> MetricFilterClauses { get; set; }
Property Value
Type Description
IList<MetricFilterClause>

Metrics

The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.

Declaration
[JsonProperty("metrics")]
public virtual IList<Metric> Metrics { get; set; }
Property Value
Type Description
IList<Metric>

OrderBys

Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.

Declaration
[JsonProperty("orderBys")]
public virtual IList<OrderBy> OrderBys { get; set; }
Property Value
Type Description
IList<OrderBy>

PageSize

Page size is for paging and specifies the maximum number of returned rows. Page size should be &gt;= 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.

Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Pivots

The pivot definitions. Requests can have a maximum of 2 pivots.

Declaration
[JsonProperty("pivots")]
public virtual IList<Pivot> Pivots { get; set; }
Property Value
Type Description
IList<Pivot>

SamplingLevel

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.

Declaration
[JsonProperty("samplingLevel")]
public virtual string SamplingLevel { get; set; }
Property Value
Type Description
string

Segments

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.

Declaration
[JsonProperty("segments")]
public virtual IList<Segment> Segments { get; set; }
Property Value
Type Description
IList<Segment>

ViewId

The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.

Declaration
[JsonProperty("viewId")]
public virtual string ViewId { get; set; }
Property Value
Type Description
string

Implements