Experiment flags

This topic explains how you can use experiment flags to test a hypothesis. These flags help you validate the impact of features you roll out to your app or infrastructure.

​

About experiment flags

Experiment flags are temporary flags. In the most common use case, you wrap an experiment flag around code for a new or improved feature that impacts end users. Experiment flags can be either boolean or multivariate, so that the experiment can test multiple values. You can pair flags with metrics to compare context or system behavior between two or more flag variations. To learn more, read Experimentation.

​

Create experiment flags

To create an experiment flag:

1. Click Create and choose Flag. The “Create flag” dialog appears.

2. Enter a unique, human-readable Name. A suggested key auto-populates from the name you enter, but you can customize it if you wish.
3. (Optional) Click Edit key to update the flag key. You’ll use this key to reference the flag in your code.
4. (Optional) Enter a Description of the flag. A brief, human-readable description helps your account members understand what the flag is for.
5. (Optional) Click Custom and select Experiment. The flag type updates to String.

6. (Optional) Click + to add additional variations.
7. (Optional) Click a variation name to edit its name and value.
8. (Optional) Click Schema to validate the variations using a JSON schema.
   • Click the magic wand icon to suggest a JSON schema based on your existing variation values.
   • Click the broom icon to format the JSON schema.

   

9. (Optional) Change the default on and default off variations if needed.
10. (Optional) Click on your member name to change the flag maintainer.
11. (Optional) Click the tag icon to add one or more tags.
12. (Optional) Click the views icon to add the flag to a view.
13. (Optional) Click All SDKs to make the flag unavailable to client-side or mobile SDKs. Flags are available to all SDKs by default.
14. (Optional) Click Prerequisite to add a prerequisite flag.
15. Click Create flag.

The flag Targeting tab appears. After you create a flag, you can make further changes to it as needed, such as to update flag targeting. To learn more, read Creating new flags. Then, run experiments on the flag. To get started, click Add experiment the flag’s right sidebar. To learn more, read Creating experiments.

​

Modify the experiment flag template

To modify your experiment flag template:

1. Click the project dropdown. The project menu appears:

2. Select Project settings.
3. Select Flags. The Flags settings list appears.
4. In the “Flag templates” section, click the pencil icon next to “Experiment.”
5. In the “Tags” section, type to add tags to each new flag by default.
6. Click Save.

Verify that the updated default template settings are correct by navigating to the Flags list and creating a new experiment flag.