Class RunRealtimeReportRequest

The request to generate a realtime report.

Inheritance

object

RunRealtimeReportRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.AnalyticsData.v1beta.Data

Assembly: Google.Apis.AnalyticsData.v1beta.dll

Syntax

public class RunRealtimeReportRequest : IDirectResponseSchema

Properties

DimensionFilter

The filter clause of dimensions. Metrics cannot be used in this filter.

Declaration

[JsonProperty("dimensionFilter")]
public virtual FilterExpression DimensionFilter { get; set; }

Property Value

Type	Description
FilterExpression

Dimensions

The dimensions requested and displayed.

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

Limit

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 requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

Declaration

[JsonProperty("limit")]
public virtual long? Limit { get; set; }

Property Value

Type	Description
long?

MetricAggregations

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

Declaration

[JsonProperty("metricAggregations")]
public virtual IList<string> MetricAggregations { get; set; }

Property Value

Type	Description
IList<string>

MetricFilter

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

Declaration

[JsonProperty("metricFilter")]
public virtual FilterExpression MetricFilter { get; set; }

Property Value

Type	Description
FilterExpression

Metrics

The metrics requested and displayed.

Declaration

[JsonProperty("metrics")]
public virtual IList<Metric> Metrics { get; set; }

Property Value

Type	Description
IList<Metric>

MinuteRanges

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

Declaration

[JsonProperty("minuteRanges")]
public virtual IList<MinuteRange> MinuteRanges { get; set; }

Property Value

Type	Description
IList<MinuteRange>

OrderBys

Specifies how rows are ordered in the response.

Declaration

[JsonProperty("orderBys")]
public virtual IList<OrderBy> OrderBys { get; set; }

Property Value

Type	Description
IList<OrderBy>

ReturnPropertyQuota

Toggles whether to return the current state of this Google Analytics property's Realtime quota. Quota is returned in PropertyQuota.

Declaration

[JsonProperty("returnPropertyQuota")]
public virtual bool? ReturnPropertyQuota { get; set; }

Property Value

Type	Description
bool?

Implements

IDirectResponseSchema