diff --git a/docs/default_rules.rst b/docs/default_rules.rst index e73258f..276f412 100644 --- a/docs/default_rules.rst +++ b/docs/default_rules.rst @@ -25,13 +25,13 @@ Select one or multiple days on which you'd like your segment to be applied. ================== ========================================================== Option Description ================== ========================================================== -Monday Matches when the visitors visits on monday. -Tuesday Matches when the visitors visits on tuesday. -Wednesday Matches when the visitors visits on wednesday. -Thursday Matches when the visitors visits on thursday. -Friday Matches when the visitors visits on friday. -Saturday Matches when the visitors visits on saturday. -Sunday Matches when the visitors visits on sunday. +Monday Matches when the visitors visits on a monday. +Tuesday Matches when the visitors visits on a tuesday. +Wednesday Matches when the visitors visits on a wednesday. +Thursday Matches when the visitors visits on a thursday. +Friday Matches when the visitors visits on a friday. +Saturday Matches when the visitors visits on a saturday. +Sunday Matches when the visitors visits on a sunday. ================== ========================================================== ``personalisation.models.DayRule`` @@ -53,3 +53,71 @@ Regex string The regex string to match the referral header to. ================== ========================================================== ``personalisation.models.ReferralRule`` + +Visit count rule +---------------- + +The visit count rule allows you to segment a visitor based on the amount of +visits per page. Use the operator to to set a maximum, minimum or equal +amount of visits. + +================== ========================================================== +Option Description +================== ========================================================== +Page The page on which visits will be counted. +Count The amount of visits to match. +Operator Whether to match for more than, less than or equal to the + specified visit count. +================== ========================================================== + +``personalisation.models.VisitCountRule`` + +Query rule +---------- + +The query rule allows you to match a visitor based on the query included in +the url. It let's you define both the parameter and the value. It will look +something like this: + +.. code-block:: bash + + example.com/?campaign=ourbestoffer + +================== ========================================================== +Option Description +================== ========================================================== +Parameter The first part of the query ('campaign'). +Value The second part of the query ('ourbestoffer'). +================== ========================================================== + +``personalisation.models.QueryRule`` + +Device rule +----------- + +The device rule allows you to match visitors by the type of device they are +using. You can select any combination you want. + +================== ========================================================== +Option Description +================== ========================================================== +Mobile phone Matches when the visitor uses a mobile phone. +Tablet Matches when the visitor uses a tablet. +Desktop Matches when the visitor uses a desktop. +================== ========================================================== + +``personalisation.models.DeviceRule`` + +User is logged in rule +---------------------- + +The user is logged in rule allows you to match visitors that are authenticated +and logged in to your app. + +================== ========================================================== +Option Description +================== ========================================================== +Is logged in Whether the user is logged in or logged out. +================== ========================================================== + +``personalisation.models.UserIsLoggedInRule``