Using ActivateExperiment with user attributes

Method

1. string variationName = pageSenseClient.ActivateExperiment(experimentName, userId, userAttributes); 
   

Parameter details:

Return Value

1. Returns the name of the allocated variation if the user qualifies for the FullStack A/B experiment.
   
2. Returns null if the user does not meet the audience targeting criteria and fails to qualify for the FullStack A/B Experiment.
   

Usage Example

1. // Create the User Attributes object
2. Dictionary<string, string> userAttributes = new Dictionary<string, string>();
3.  
4. // Add the User Attribute values
5. userAttributes["Browser"] = "Chrome";
6. userAttributes["Device"] = "Desktop";
7. userAttributes["OS"] = "Windows 10";
8.  
9. // Activate the FullStack A/B Test Experiment
10. string variationName = pageSenseClient.ActivateExperiment(experimentName, userId, userAttributes);
11.  
12. // Define the Code Changes for each of the Variations of the FullStack A/B Test Experiment
13.  
14. if (variationName.Equals("Original")){
15. // CODE: Write code for handling 'Original'
16. } else if (variationName.Equals("Variation 1")){
17.  // CODE: Write code for handling 'Variation 1'
18. }else if (variationName.Equals("Variation 2")){
19. // CODE: Write code for handling 'Variation 2' 
20. } else if (variationName.Equals("Variation 3")){
21.  // CODE: Write code for handling 'Variation 3'
22. } else{
23. // CODE: When user is not part of FullStack A/B Test Experiment.
24. } 
    

API Functionality Overview

Audience Targeting

1. If the user’s attributes match the audience targeting conditions, the API proceeds to the next step.
   
2. If the user does not meet these conditions, the API immediately returns null, indicating that the user is not eligible to be included in the experiment.
   

User Storage Service

1. If a variation has already been assigned and stored for the user in the User Storage Service, the API retrieves and returns that stored variation.
   
2. If no stored variation exists, the API proceeds to allocate a new variation using the bucketing logic described below.
   

Hashing with MurmurHash

1. The API applies the MurmurHash algorithm to the user's ID (userId). This hashing algorithm consistently generates a unique numeric value between 0 and 9999 for each user ID, which serves as the user's hash value.
   
2. MurmurHash algorithm always generate the same hash value for the User ID for a given experiment across different sessions. This ensures deterministic and sticky variation assignment to the user for a given experiment.
   

Variation Mapping

1. "Original" variation is assigned a hash range from 0–2000
   
2. "Variation 1" is assigned a hash range from 2001–4000
   
3. "Variation 2" is assigned a hash range from–6000 and so on.
   

1. If it does, the corresponding variation is allocated to the user.
   
2. If the hash value falls outside all assigned ranges, it means the user is not within the experiment’s traffic allocation, and null is returned.
   

Tracking and Analytics

Return Value

1. If the user qualifies for the experiment and a variation is successfully allocated, the API returns the name of the variation allocated.
   
2. If the user fails to qualify for the experiment at any stage, the API returns null.
   

Using ActivateExperiment without user attributes

Method 

API Functionality Overview

1. In this version of the API, only the experiment name and user ID are required.
   
2. The audience targeting step is still executed; however, since no user attributes are provided, the user will qualify only for the experiments where the audience targeting criteria is configured as “All Visitors.”
   
3. If the experiment includes any additional audience targeting conditions—such as device type, location, or custom attributes—the user will automatically fail the qualification check due to the absence of use attribute data for evaluation.
   
4. For experiments that allow “All Visitors,” the standard MurmurHash-based variation allocation logic is applied. If the user's hash value falls within the defined range of any variation, that variation is allocated, and the API returns the name of the assigned variation.
   
5. If the user's hash value falls outside all defined variation ranges—due to the experiment’s traffic allocation configuration—no variation is allocated, and the API returns null.