View Source GoogleApi.AnalyticsData.V1alpha.Model.Cohort (google_api_analytics_data v0.14.0)
Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same firstSessionDate
belong to the same cohort.
Attributes
-
dateRange
(type:GoogleApi.AnalyticsData.V1alpha.Model.DateRange.t
, default:nil
) - The cohort selects users whose first touch date is between start date and end date defined in thedateRange
. ThisdateRange
does not specify the full date range of event data that is present in a cohort report. In a cohort report, thisdateRange
is extended by the granularity and offset present in thecohortsRange
; event data for the extended reporting date range is present in a cohort report. In a cohort request, thisdateRange
is required and thedateRanges
in theRunReportRequest
orRunPivotReportRequest
must be unspecified. ThisdateRange
should generally be aligned with the cohort's granularity. IfCohortsRange
uses daily granularity, thisdateRange
can be a single day. IfCohortsRange
uses weekly granularity, thisdateRange
can be aligned to a week boundary, starting at Sunday and ending Saturday. IfCohortsRange
uses monthly granularity, thisdateRange
can be aligned to a month, starting at the first and ending on the last day of the month. -
dimension
(type:String.t
, default:nil
) - Dimension used by the cohort. Required and only supportsfirstSessionDate
. -
name
(type:String.t
, default:nil
) - Assigns a name to this cohort. The dimensioncohort
is valued to this name in a report response. If set, cannot begin withcohort_
orRESERVED_
. If not set, cohorts are named by their zero based indexcohort_0
,cohort_1
, etc.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.AnalyticsData.V1alpha.Model.Cohort{ dateRange: GoogleApi.AnalyticsData.V1alpha.Model.DateRange.t() | nil, dimension: String.t() | nil, name: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.