Struct CohortSpec

pub struct CohortSpec {
    pub cohort_report_settings: Option<CohortReportSettings>,
    pub cohorts: Option<Vec<Cohort>>,
    pub cohorts_range: Option<CohortsRange>,
}

The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the cohort object. Following that cohort for the next six weeks is specified in the cohortsRange object. For examples, see Cohort Report Examples. The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric cohortActiveUsers/cohortTotalUsers and will be separate rows in the report.

This type is not used in any activity, and only used as part of another schema.

Fields

cohort_report_settings: Option<CohortReportSettings>

Optional settings for a cohort report.

cohorts: Option<Vec<Cohort>>

Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.

cohorts_range: Option<CohortsRange>

Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over.

Trait Implementations

impl Clone for CohortSpec

fn clone(&self) -> CohortSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CohortSpec

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

Formats the value using the given formatter.

impl Default for CohortSpec

fn default() -> CohortSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CohortSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CohortSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for CohortSpec