Struct AnalyticsQuery 

pub struct AnalyticsQuery {
    pub period: Option<TimePeriod>,
    pub date_range: Option<DateRange>,
    pub granularity: Option<TimeGranularity>,
    pub limit: Option<u32>,
    pub compare_previous: Option<bool>,
}

Common analytics query parameters

Fields

period: Option<TimePeriod>

Time period preset

date_range: Option<DateRange>

Custom date range (used when period is Custom)

granularity: Option<TimeGranularity>

Time granularity for time-series data

limit: Option<u32>

Number of results to return (for top-N queries)

compare_previous: Option<bool>

Compare to previous period

Implementations

impl AnalyticsQuery

pub fn new() -> AnalyticsQuery

Create a new analytics query with defaults

pub const fn period(self, period: TimePeriod) -> AnalyticsQuery

Set a predefined time period

pub const fn date_range( self, start: DateTime<Utc>, end: DateTime<Utc>, ) -> AnalyticsQuery

Set a custom date range and switch to custom period

pub const fn granularity(self, granularity: TimeGranularity) -> AnalyticsQuery

Set the time granularity for time-series results

pub const fn limit(self, limit: u32) -> AnalyticsQuery

Limit the number of results returned

pub const fn compare_previous(self, compare: bool) -> AnalyticsQuery

Enable or disable comparison to the previous period

Trait Implementations

impl Clone for AnalyticsQuery

fn clone(&self) -> AnalyticsQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnalyticsQuery

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

Formats the value using the given formatter.

impl Default for AnalyticsQuery

fn default() -> AnalyticsQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnalyticsQuery

fn deserialize<__D>( __deserializer: __D, ) -> Result<AnalyticsQuery, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AnalyticsQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.