Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.51 KB

PreviewMode.md

File metadata and controls

31 lines (19 loc) · 1.51 KB

Preview Mode

Preview mode is a feature which enables you to force the group that you appear in for any experiments in Canvass. Essentially, it causes Canvass to bypass the Provider when setting the group for an enrolled experiment.

This feature is very useful for testing, debugging and demoing experiments.

Using Preview Mode

Preview mode is activated using a query string. The different modes that are supported are described below. Simply append the query string to the url of your web application.

The preview mode that you set will persist for the current session (even if you remove the query string and refresh). To turn preview mode off, use the "off" mode described below or open a new tab in your browser.

"All" Mode

This mode enables the challenging variant of all experiments by default. All enrolled experiments will activate with a group of 1.

?canvassPreviewMode=all

"None" Mode

This mode enables the control variant of all experiments by default. All enrolled experiments will activate with a group of 0.

?canvassPreviewMode=none

"Custom" Mode

This mode enables you to explicitly define the group that you will receive for specific experiments.

?canvassPreviewMode={"MyExperiment":1,"MyOtherExperiment:2"}

will place you in group 1 when MyExperiment enrolls and group 2 when MyOtherExperiment enrolls. Note that any other experiments not explicitly named in custom mode will receive a group of 0 by default.

"Off" Mode

This mode is used to turn preview mode off.

?canvassPreviewMode=off