Struct RunRealtimeReportRequest

pub struct RunRealtimeReportRequest {
    pub dimension_filter: Option<FilterExpression>,
    pub dimensions: Option<Vec<Dimension>>,
    pub limit: Option<i64>,
    pub metric_aggregations: Option<Vec<String>>,
    pub metric_filter: Option<FilterExpression>,
    pub metrics: Option<Vec<Metric>>,
    pub minute_ranges: Option<Vec<MinuteRange>>,
    pub order_bys: Option<Vec<OrderBy>>,
    pub return_property_quota: Option<bool>,
}

The request to generate a realtime report.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• run realtime report properties (request)

Fields

dimension_filter: Option<FilterExpression>

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

dimensions: Option<Vec<Dimension>>

The dimensions requested and displayed.

limit: Option<i64>

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.

metric_aggregations: Option<Vec<String>>

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

metric_filter: Option<FilterExpression>

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

metrics: Option<Vec<Metric>>

The metrics requested and displayed.

minute_ranges: Option<Vec<MinuteRange>>

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.

order_bys: Option<Vec<OrderBy>>

Specifies how rows are ordered in the response.

return_property_quota: Option<bool>

Toggles whether to return the current state of this Analytics Property’s Realtime quota. Quota is returned in PropertyQuota.

Trait Implementations

impl Clone for RunRealtimeReportRequest

fn clone(&self) -> RunRealtimeReportRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunRealtimeReportRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RunRealtimeReportRequest

fn default() -> RunRealtimeReportRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunRealtimeReportRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunRealtimeReportRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for RunRealtimeReportRequest