Traffic Distribution

Traffic distribution into the different test groups of the A/B test.

When conducting an A/B test, not only do you need to distribute your users to different test groups, you also need to write a logic for each test group. After the integration stages, the distribution of users into different test groups can be done through the Hackle SDK.

πŸ“˜

Test Groups

The test groups are basically the different groups that are exposed to the versions (features, screens, algorithms, etc) of a page of an experiment. Test groups include both the control test group A and treatment test groups B, C, D, etc., that are exposed to the "improved" versions of the pages.
The test groups can be set on the dashboard and further information on the test groups can be found on the What is a Test Group? document.

variation

Think of the variation as the term that is equivalent to different versions of the page being shown to users on your app or browser.
By passing the experiment key and user identifier to the variation() method, you can distribute particular users and receive the result for the specific experiment. After that, we implement the logic of the page version applicable for each test group.

In the example code below, we are passing the experimental key 42, the user identifier is "ae2182e0" . There are two test groups, A and B.

// Determines the test group to assign the user "ae2182e0"
// in an A/B tests with an experiment key of 42.
// For undetermined cases, the user is returned to test group A.

Variation variation = hackleClient.variation(42, "ae2182e0");

// Logic for the different test groups
if (variation == Variation.A) {
  // Logic for test group A
} else if (variation == Variation.B) {
  // Logic for test group B
}
// Determines the test group to assign the user "ae2182e0"
// in an A/B tests with an experiment key of 42.
// For undetermined cases, the user is returned to test group A.

val variation = hackleClient.variation(42, "ae2182e0")

// Logic for the different test groups
if (variation == Variation.A) {
  // Logic for test group A
} else if (variation == Variation.B) {
  // Logic for test group B
}

variationDetail

The variationDetail() method works the same as the variation() method but provides the reason for a user being distributed to a specific group. This method can be a useful tool to see if the distribution is working properly.
You must pass the experiment key as a parameter. For the example code below, we are passing experimental key 42.

// Traffic distribution details 
Decision decision = hackleClient.variationDetail(42, "ae2182e0");

// Test group determined from distribution
Variation variation = decision.getVariation();

// Reason for distribution to a test group
DecisionReason reason = decision.getReason();
// Traffic distribution details 
val decision = hackleClient.variationDetail(42, "ae2182e0")

// Test group determined from distribution
val variation = decision.variation

// Reason for distribution to a test group
val reason = decision.reason

You will receive the reason for the distribution or the allocation of a specific user to a specific test group in the form of SDK_NOT_READY. Please refer to the table below for the full list of different distribution reasons.

ReasonDescriptionDistribution Result
SDK_NOT_READYThe SDK is not ready to use.
(e.g. initialized with the wrong SDK key)
(control) Test Group A
EXPERIMENT_NOT_FOUNDNo A/B tests were found for the experimental key you passed.
The experiment key may be incorrect or the experiment may be in the archive status.
(control) Test Group A
EXPERIMENT_DRAFTThe A/B test has not yet been started (in draft mode).(control) Test Group A
EXPERIMENT_PAUSEDThe A/B test has been paused.(control) Test Group A
EXPERIMENT_COMPLETEDThe A/B test has ended.Final winning test group from the experiment
OVERRIDDENUsers are distributed to a specific test group by manual assignment.Manually assigned test group
TRAFFIC_NOT_ALLOCATEDA/B test is running, but user has not been assigned to the experiment.(control) Test Group A
TRAFFIC_ALLOCATEDUser has been assigned to a test group in the A/B test.Assigned test group
VARIATION_DROPPEDThe test group was removed from the A/B test.(control) Test Group A
EXCEPTIONAn unknown error has occurred.(control) Test Group A

Parameter

  • Parameter values of the distributed group can also be provided through the variationDetail() method.
  • In the Decision instance passed through the variationDetail() method, there is a ParameterConfig object which contains all parameter setting information.
  • Parameter values you've set on the dashboard exists in the form of key and value, therefore you can use the method below to set the parameter values.

πŸ“˜

Parameter setting is only available for SDK version 2.8.0 or higher.

getString

  • Returns the parameter value set to STRING, JSON type.
  • Returns the set value of the distributed group.
Decision decision = hackleClient.variationDetail(42, "ae2182e0");
ParameterConfig config = decision.getConfig();
  
String strValue = decision.getString("parameter_key_string_type", "defaultValue");
String strValueInConfig = config.getString("parameter_key_string_type", "defaultValue");
  
String jsonValue = decision.getString("parameter_key_json_type", "defaultValue");
String jsonValueInConfig = config.getString("parameter_key_json_type", "defaultValue");
val decision: Decision = hackleClient.variationDetail(42, "ae2182e0")
val config: ParameterConfig = decision.config

val strValue: String = decision.getString("parameter_key_string_type", "defaultValue")
val strValueInConfig: String = config.getString("parameter_key_string_type", "defaultValue")

val jsonValue: String = decision.getString("parameter_key_json_type", "defaultValue")
val jsonValueInConfig: String = config.getString("parameter_key_json_type", "defaultValue")

getInt

  • Returns the parameter value set to Number type as Int type.
  • Returns the set value of the distributed group.
Decision decision = hackleClient.variationDetail(42, "ae2182e0");
ParameterConfig config = decision.getConfig();
  
int intValue = decision.getInt("parameter_key_number_type", 0);
int intValueInConfig = config.getInt("parameter_key_number_type", 0);
val decision: Decision = hackleClient.variationDetail(42, "ae2182e0")
val config: ParameterConfig = decision.config
  
val intValue: Int = decision.getInt("parameter_key_number_type", 0)
val intValueInConfig: Int = config.getInt("parameter_key_number_type", 0)

getDouble

  • Returns the parameter value set to Number type as Double type.
  • Returns the set value of the distributed group.
Decision decision = hackleClient.variationDetail(42, "ae2182e0");
ParameterConfig config = decision.getConfig();
  
double doubleValue = decision.getDouble("parameter_key_number_type", 0.0);
double doubleValueInConfig = config.getDouble("parameter_key_number_type", 0.0);
val decision: Decision = hackleClient.variationDetail(42, "ae2182e0")
val config: ParameterConfig = decision.config
  
val doubleValue: Double = decision.getDouble("parameter_key_number_type", 0.0)
val doubleValueInConfig: Double = config.getDouble("parameter_key_number_type", 0.0)

getLong

  • Returns the parameter value set to Number type as Long type.
  • Returns the set value of the distributed group.
Decision decision = hackleClient.variationDetail(42, "ae2182e0");
ParameterConfig config = decision.getConfig();
  
long longValue = decision.getLong("parameter_key_number_type", 0L);
long longValueInConfig = config.getLong("parameter_key_number_type", 0L);
val decision: Decision = hackleClient.variationDetail(42, "ae2182e0")
val config: ParameterConfig = decision.config
  
val longValue: Long = decision.getLong("parameter_key_number_type", 0L)
val longValueInConfig: Long = config.getLong("parameter_key_number_type", 0L)

getBoolean

  • Returns the parameter value set to Boolean type.
  • Returns the set value of the distributed group.
Decision decision = hackleClient.variationDetail(42, "ae2182e0");
ParameterConfig config = decision.getConfig();

boolean booleanValue = decision.getBoolean("parameter_key_boolean_type", false);
boolean booleanValueInConfig = config.getBoolean("parameter_key_boolean_type", false);
val decision: Decision = hackleClient.variationDetail(42, "ae2182e0")
val config: ParameterConfig = decision.config
  
val booleanValue: Boolean = decision.getBoolean("parameter_key_boolean_type", false)
val booleanValueInConfig: Boolean = config.getBoolean("parameter_key_boolean_type", false)

πŸ“˜

Deduplication of exposure event

If you use Backend-side SDK, Any successive Exposure events within one minute for same A/B test from single user will be counted as one.