HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Get All Feature Variables

This topic describes the Get All Feature Variables method, which evaluates and returns all feature variables for the specified feature flag.

Evaluates and returns all feature variables for the specified feature flag.

This method takes into account the user attributes passed in, to determine if the user is part of the audience that qualifies for the experiment.

Sample call

public OptimizelyJSON getAllFeatureVariables(@Nonnull String featureKey,
                                             @Nonnull String userId,
                                             @Nonnull Map<String, ?> attributes)

Version

SDK v3.5 and higher

Description

For each feature variable associated with the feature flag, Get All Feature Variables returns all feature variable keys. For each key, it returns either the default or the user-specific variable value, depending on which audience the user is bucketed into. For example:

  • If the user is in a "Beta" audience on a feature rollout, this method returns user-specific values: {"welcome_snippet": "you're in our beta!", "new_feature_color": "red"}.
  • If the user is in a feature tests's control_variation in which the feature is disabled, this method returns the default values: {"welcome_snippet": "", "new_feature_color": "grey"}.

Note that depending on the audience rules, this method can return a mix of default and user-specific variable values.

🚧

Important

Unlike Is Feature Enabled, the Get All Feature Variables method does not trigger an impression event. This means that if you are running a feature test, events will not be counted until you call Is Feature Enabled. If you do not call Is Feature Enabled, you will not see any visitors on your results page.

Parameters

Required and optional parameters are listed below.

Parameter

Type

Description

featureKey
required

string

The feature key is defined from the Features dashboard; see Use feature flags.

userId
required

string

The user ID string uniquely identifies the participant in the experiment. For more information, see: Handle user IDs.

attributes
required

map

A map of custom key-value string pairs specifying attributes for the user that are used for Target audiences and results segmentation. Non-string values are only supported in the 3.0 SDK and above.

Returns

Returns an OptimizelyJSON object. For example, you can call your_returned_OptJson.toMap() to get the following example JSON representation:

{
   "double_key": 10.02,
   "int_key": 4243,
   "string_key": "staging",
   "bool_key": true,
   "json_key1": {
     "test": 123,
     "test_2": "en-us"
    },
   "json_key2": {
     "test_3": 1.4
    }
}

Example

Map<String, Object> attributes = new HashMap<>();
attributes.put("device", "iPhone");
attributes.put("lifetime", 24738388);

OptimizelyJSON json = optimizelyClient.getAllFeatureVariables("my_feature_key",
                                                              "user_123",
                                                              attributes);

See also

Get Feature Variable

Side effects

Invokes the DECISION notification listener if this listener is enabled. Sends only one notification for all variables.

Source files

The language/platform source files containing the implementation for Java is Optimizely.java.


Did this page help you?