From 0f48701384c022f908d09e98d07f035df8a9c782 Mon Sep 17 00:00:00 2001 From: RomainLibert Date: Tue, 10 Jul 2018 11:13:28 +0200 Subject: [PATCH] [DOC] web_cohort: documents mode attribute Closes #25512 --- doc/reference/views.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/reference/views.rst b/doc/reference/views.rst index cbb85b71c83..eca2a0ad73f 100644 --- a/doc/reference/views.rst +++ b/doc/reference/views.rst @@ -1336,6 +1336,11 @@ attributes: A valid date or datetime field. This field is understood by the view as the end date of a record. This is the field that will determine the churn. +- ``mode`` (optional) + A string to describe the mode. It should be either 'churn' or + 'retention' (default). Churn mode will start at 0% and accumulate over time + whereas retention will start at 100% and decrease over time. + - ``interval`` (optional) A string to describe a time interval. It should be 'day', 'week', 'month'' (default) or 'year'.