Class: DatadogAPIClient::V2::ProductAnalyticsRetentionSearch

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/product_analytics_retention_search.rb

Overview

Defines the cohort and return criteria that make up a retention query.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_propertiesObject

Returns the value of attribute additional_properties.



40
41
42
# File 'lib/datadog_api_client/v2/models/product_analytics_retention_search.rb', line 40

def additional_properties
  @additional_properties
end

#cohort_criteriaObject

Defines the event that places an entity into a cohort, and how cohorts are bucketed over time.



25
26
27
# File 'lib/datadog_api_client/v2/models/product_analytics_retention_search.rb', line 25

def cohort_criteria
  @cohort_criteria
end

#filtersObject

Filters narrowing the events considered by a retention query.



28
29
30
# File 'lib/datadog_api_client/v2/models/product_analytics_retention_search.rb', line 28

def filters
  @filters
end

#retention_entityObject

The entity whose retention is measured.



31
32
33
# File 'lib/datadog_api_client/v2/models/product_analytics_retention_search.rb', line 31

def retention_entity
  @retention_entity
end

#return_conditionObject

When an entity counts as having returned. Use conversion_on to count only entities that returned during the period itself, or conversion_on_or_after to also count later returns.



35
36
37
# File 'lib/datadog_api_client/v2/models/product_analytics_retention_search.rb', line 35

def return_condition
  @return_condition
end

#return_criteriaObject

Defines the event that counts as a return, and the window in which it must occur.



38
39
40
# File 'lib/datadog_api_client/v2/models/product_analytics_retention_search.rb', line 38

def return_criteria
  @return_criteria
end