The Rollouts Developer Hub

Welcome to the Rollouts developer hub. You'll find comprehensive guides and documentation to help you start working with Rollouts as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Target audiences

Audiences give you control over which users are included in a rollout and have access to your feature.

You'll describe which users to include based on custom attributes like their location, device type, or subscription plan. After you create an audience, you can add it to your feature.

A single audience is defined based on user attributes. These attributes are properties of a user that you pass in when calling APIs like Is Feature Enabled. When you pass attribute values, Optimizely uses them to determine whether the user qualifies for rollout.

Create an audience

After you've created a few attributes, you can start building audiences. Audiences help you target your feature to certain groups of users. You can reuse audiences that you've created across multiple features.

Rollouts supports several match types that you can use in audience conditions:

  • has any value
  • String equals
  • String contains substring
  • Boolean is false
  • Boolean is true
  • Number equals
  • Number is less than
  • Number equals
  • Number is greater than

The Edit Audience window lets you define audience conditions by either dragging and dropping attributes from the right side pane or defining complex JSON objects using the Code Mode window.

To drag and drop attributes:

  1. Navigate to Audiences > Saved.
  2. Click Create New Audience.
  3. Drag and drop the desired attributes into the Audience Conditions field.
    For example, to create an audience of visitors who are located in the US, based on specific location values, add the "LOCATION" attribute.
  4. Define the attributes.
    Add other attributes to help create your audience. They can be can be added as "and" or "or" conditions. When you choose any match type option other than String equals for exact matching, a message displays that the option requires using an SDK version of 3.0, at minimum.
  5. Click Save Audience.

To use Code Mode to create a custom JSON object:

  1. Create a new audience or select an existing audience to edit. The Edit Audience window appears.
  2. Click Code Mode to access the Edit Code Mode window.
  3. Create the necessary JSON object for your use case. For more information, see Audience Conditions.
  4. Clear the Code Mode checkbox to exit the editing mode.

After creating an audience, you can set the target audience or audiences for an A/B test, feature test, or feature rollout.

Updated 7 months ago

Target audiences

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.