Admin::Cohort

Example

Monthly retention data for the month of 2022-09, given that 2 users registered during 2022-09 and were active at least once during that month.

{ "period": "2022-09-01T00:00:00+00:00", "frequency": "month", "data": [ { "date": "2022-09-01T00:00:00+00:00", "rate": 1.0, "value": "2" } ] } 

Daily retention data for the week between 2022-09-08 and 2022-09-14, given that 2 users registered on 2022-09-08 and 1 of those users stopped being active after 2022-09-09.

{ "period": "2022-09-08T00:00:00+00:00", "frequency": "day", "data": [ { "date": "2022-09-08T00:00:00+00:00", "rate": 1.0, "value": "2" }, { "date": "2022-09-09T00:00:00+00:00", "rate": 1.0, "value": "2" }, { "date": "2022-09-10T00:00:00+00:00", "rate": 0.5, "value": "1" }, { "date": "2022-09-11T00:00:00+00:00", "rate": 0.5, "value": "1" }, { "date": "2022-09-12T00:00:00+00:00", "rate": 0.5, "value": "1" }, { "date": "2022-09-13T00:00:00+00:00", "rate": 0.5, "value": "1" }, { "date": "2022-09-14T00:00:00+00:00", "rate": 0.5, "value": "1" } ] } 

Attributes

period

Description: The timestamp for the start of the period, at midnight.
Type: String (Datetime)
Version history:
3.5.0 - added

frequency

Description: The size of the bucket for the returned data.
Type: String (Enumerable oneOf)
day = Daily buckets
month = Monthly buckets
Version history:
3.5.0 - added

data

Description: Retention data for users who registered during the given period.
Type: Array of CohortData
Version history:
3.5.0 - added

CohortData entity attributes

date

Description: The timestamp for the start of the bucket, at midnight.
Type: String (Datetime)
Version history:
3.5.0 - added

rate

Description: The percentage rate of users who registered in the specified period and were active for the given date bucket.
Type: Number
Version history:
3.5.0 - added

value

Description: How many users registered in the specified period and were active for the given date bucket.
Type: String (cast from integer)
Version history:
3.5.0 - added

See also

Last updated May 13, 2025 · Improve this page