C# SDK

Integrate the Kameleoon C# SDK to run server-side experiments and activate feature flags on .NET application servers.

Welcome to the developer documentation for the Kameleoon C# SDK! Use our SDK to run experiments on your back-end .NET application server. It is easy to integrate our SDK into your web-application, and its memory and network usage are low.

Getting started: For help getting started, see the developer guide.

SDK methods: For the full reference documentation of the C# SDK methods, see the reference section.

Changelog: Latest version of the C# SDK: 4.22.1 changelog.

Developer guide

Getting started

This guide is designed to help you integrate our SDK into your C# applications.

Starter kit

To help with getting started, Kameleoon provides a starter kit and demo application to test the SDK. The starter kit includes a fully configured app with examples demonstrating how SDK methods can be used in an app. The starter kit, demo application, and detailed instructions are available at Starter kit for .NET

Install the C# client

You can use the NuGet, .NET CLI, or Paket package manager to install the C# client.

NuGet Package Manager

Install-Package KameleoonClient

.NET CLI

dotnet add package KameleoonClient

Paket CLI

paket add KameleoonClient

Additional configuration

Create a .properties configuration file to provide credentials and customize the SDK’s behavior. You can also download a sample configuration file. Save this file in the default path /etc/kameleoon/client-csharp.conf. If you place the file in another location, you’ll need to pass the path as an argument to KameleoonClientFactory.Create(). With the current version of the C# SDK, these are the available keys:

Key	Description	Default value
clientId / client_id required	Required for authentication to the Kameleoon service. To find your client_id, see the API credentials documentation.
clientSecret / client_secret required	Required for authentication to the Kameleoon service. To find your client_secret, see the API credentials documentation.
sessionDurationMinute / session_duration_minute optional	Designates the predefined time interval that Kameleoon stores the visitor and their associated data in memory (RAM). Note that increasing the session duration increases the amount of RAM that needs to be allocated to store visitor data.	30 minutes
refreshIntervalMinute / refresh_interval_minute optional	Specifies the refresh interval, in minutes, that the SDK fetches the configuration for the active experiments and feature flags. The value determines the maximum time it takes to propagate changes, such as activating or deactivating feature flags or launching experiments, to your production servers. Additionally, we offer a streaming mode that uses server-sent events (SSE) to push new configurations to the SDK automatically and apply new configurations in real-time, without any delays.	60 minutes
defaultTimeoutMillisecond / default_timeout_millisecond optional	Specifies the timeout, in milliseconds, for network requests from the SDK. Set the value to 30 seconds or more if you do not have a stable connection. Some methods have an additional parameter that you can use to override the default timeout for that particular method. If you do not specify the timeout for a method explicitly, the SDK uses this default value.	10000 milliseconds
trackingIntervalMilliseconds / tracking_interval_millisecond optional	Specifies the interval for tracking requests in milliseconds. All visitors who Kameleoon evaluated for any feature flag or had data flushed are included in this tracking request, which the SDK performs once per interval. The minimum value is 1000 ms, which is also the default, and the maximum value is 5000 ms.	1000 milliseconds
environment / environment optional	Environment from which the feature flag’s configuration is to be used. The value can be production, staging, development. See the managing environments article for details.	production
topLevelDomain / top_level_domain (required in hybrid mode)	The current top-level domain for your website. Use the format: example.com. Don’t include https://, www, or other subdomains. Kameleoon uses this information to set the corresponding cookie on the top-level domain.	null
proxyHost / proxy_host optional	Sets the proxy host for all outgoing server calls made by the SDK.	null
networkDomain / network_domain optional	Custom domain used by SDKs for outgoing requests, often for proxying. Must be a valid domain (e.g., example.com or sub.example.com). Invalid formats default to Kameleoon’s value.	null

Initialize the Kameleoon client

After you’ve installed the SDK and configured your credentials and SDK behavior, create the Kameleoon client in your application code. For example:

using Kameleoon;

string siteCode = "a8st4f59bj";

try {
    // Read from default configuration path: "/etc/kameleoon/client-csharp.conf"
    IKameleoonClient kameleoonClient = KameleoonClientFactory.Create(siteCode);
} catch (KameleoonException.SiteCodeIsEmpty e) {
    // indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
    // indicates that provided clientId / clientSecret are not valid
}

try {
    IKameleoonClient kameleoonClient = KameleoonClientFactory.Create(siteCode, "custom/file/path/client-csharp.conf");
} catch (KameleoonException.SiteCodeIsEmpty e) {
    // indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
    // indicates that provided clientId / clientSecret are not valid
}

try {
    KameleoonClientConfig config = new KameleoonClientConfig(
        clientId: "<clientId>", // mandatory
        clientSecret: "<clientId>", // mandatory
        refreshIntervalMinute: 60, // in minutes, optional (60 minutes by default)
        sessionDurationMinute: 30, // in minutes, optional (30 minutes by default)
        defaultTimeoutMillisecond: 10_000, // in milliseconds, optional (10000 ms by default)
        trackingIntervalMilliseconds: 1000, // in milliseconds, optional (1000 ms by default)
        environment: "development", // optional
        topLevelDomain: "example.com", // mandatory if you use hybrid mode (engine or web experiments)
        proxyHost: "proxy.host.com", // optional
        networkDomain: "example.com", // optional
    );
    IKameleoonClient kameleoonClient = KameleoonClientFactory.Create(siteCode, config);
} catch (KameleoonException.SiteCodeIsEmpty e) {
    // indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
    // indicates that provided clientId / clientSecret are not valid
}

An IKameleoonClient is a singleton object that connects your app to the Kameleoon platform. It includes all the methods and features you need to run an experiment.

As a developer, you must ensure your app uses the correct logic for A/B testing with Kameleoon. It’s best to exclude a visitor from the experiment if you haven’t launched it yet. Excluding is simple because this fits with the default logic for variations.

Activating a feature flag

Assigning a unique ID to a user

To assign a unique ID to a user, you can use the GetVisitorCode() method. If a visitor code doesn’t exist (from the request headers cookie), the method generates a random unique ID or uses a defaultVisitorCode that you would have generated. The ID is then set in a response headers cookie.

If you are using Kameleoon in Hybrid mode, calling the GetVisitorCode() method ensures that the unique ID (visitor code) is shared between the application file engine.js (previously named, kameleoon.js) and the SDK.

Retrieving a flag configuration

To implement a feature flag in your code, you must first create the feature flag in your Kameleoon account.

To determine the status or variation of a feature flag for a specific user, you should use the GetVariation() or IsFeatureActive() method to retrieve the configuration based on the featureKey.

The GetVariation() method handles both simple feature flags with ON/OFF states and more complex flags with multiple variations. The method retrieves the appropriate variation for the user by checking the feature rules, assigning the variation, and returning it based on the featureKey and visitorCode.

The IsFeatureActive() method can be used if you want to retrieve the configuration of a simple feature flag that has only an ON or OFF state, as opposed to more complex feature flags with multiple variations or targeting options.

If your feature flag has associated variables (such as specific behaviors tied to each variation) GetVariation() also enables you to access the Variation object, which provides details about the assigned variation and its associated experiment. This method checks whether the user is targeted, finds the visitor’s assigned variation, and saves it to storage. When track=true, the SDK will send the exposure event to the specified experiment on the next tracking request, which is automatically triggered based on the SDK’s tracking_interval_millisecond. By default, this interval is set to 1000 milliseconds (1 second).

The GetVariation() method allows you to control whether tracking is done. If track=false, no exposure events will be sent by the SDK. This is useful if you prefer not to track data through the SDK and instead rely on client-side tracking managed by the Kameleoon engine, for example. Additionally, setting track=false is helpful when using the GetVariations() method, where you might only need the variations for all flags without triggering any tracking events. If you want to know more about how tracking works, view this article

Adding data points to target a user or filter / breakdown visits in reports

To target a user, ensure you’ve added relevant data points to their profile before retrieving the feature variation or checking if the flag is active. Use the AddData() method to add these data points to the user’s profile.

To retrieve data points collected on other devices or to access past user data (collected client-side when using Kameleoon in Hybrid mode), use the GetRemoteVisitorData() method. This method asynchronously fetches data from the servers. It is important to call GetRemoteVisitorData() before retrieving the variation or checking if the feature flag is active, as this data might be required to assign a user to a given variation.

To learn more about available targeting conditions, see the detailed article on the subject.

Additionally, the data points you add to the visitor profile will be available when analyzing your experiments, allowing you to filter and break down your results by factors like device and browser. Kameleoon Hybrid mode automatically collects a variety of data points on the client-side, making it easy to break down your results based on these pre-collected data points. See the complete list here.

If you need to track additional data points beyond what’s automatically collected, you can use Kameleoon’s Custom Data feature. Custom Data allows you to capture and analyze specific information relevant to your experiments. Don’t forget to call the Flush() method to send the collected data to Kameleoon servers for analysis.

To ensure your results are accurate, it’s recommended to filter out bots by using the UserAgent data type.

Tracking goal conversions

When a user completes a desired action (such as making a purchase), it is recorded as a conversion. To track conversions, use the TrackConversion() method and provide the required visitorCode and goalId parameters.

The conversion tracking request will be sent along with the next scheduled tracking request, which the SDK sends at regular intervals (defined by tracking_interval_millisecond). If you prefer to send the request immediately, use the Flush() method with the parameter instant=true.

Sending events to analytics solutions

To track conversions and send exposure events to your customer analytics solution, you must first implement Kameleoon in Hybrid mode. Then, use the GetEngineTrackingCode() method.

The GetEngineTrackingCode() method retrieves the unique tracking code required to send exposure events to your analytics solution. Using this method allows you to record events and send them to your desired analytics platform.

Cross-device experimentation

To support visitors who access an app from multiple devices, Kameleoon allows the synchronization of previously collected visitor data across each of the visitor’s devices and reconciliation of their visit history across devices through cross-device experimentation. Case studies and detailed information on how Kameleoon handles data across devices are available in the article on cross-device experimentation.

Synchronizing custom data across devices

Although custom mapping synchronization is used to align visitor data across devices, it is not always necessary. Below are two scenarios where custom mapping sync is not required:

Same user ID across devices If the same user ID is used consistently across all devices, synchronization is handled automatically without a custom mapping sync. It is enough to call the GetRemoteVisitorData() method when you want to sync the data collected between multiple devices.

Multi-server instances with consistent IDs In complex setups involving multiple servers (for example, distributed server instances), where the same user ID is available across servers, synchronization between servers (with GetRemoteVisitorData()) is sufficient without additional custom mapping sync.

Customers who need additional data can refer to the GetRemoteVisitorData() method description for further guidance. In the below code, it is assumed that the same unique identifier (in this case, the visitorCode, which can also be referred to as userId) is used consistently between the two devices for accurate data retrieval.

If you want to sync collected data in real time, you need to choose the scope Visitor for your custom data.

Device A

// In this example Custom data with index `90` was set to "Visitor" scope on Kameleoon Platform.
const int VisitorScopeCustomDataIndex = 90;

kameleoonClient.AddData(visitorCode, new CustomData(VisitorScopeCustomDataIndex, "your data"));
kameleoonClient.Flush(visitorCode);

Device B

// Before working with the data, call the `GetRemoteVisitorData` method.
await kameleoonClient.GetRemoteVisitorData(visitorCode);

// After calling the method, the SDK on Device B will have access to CustomData of Visitor scope as defined on Device A.
// So, "your data" will be available for targeting and tracking the visitor.

Using custom data for session merging

Cross-device experimentation allows for combining a visitor’s history across each of their devices (history reconciliation). History reconciliation allows merging different visitor sessions into one. To reconcile visit history, use CustomData to provide a unique identifier for the visitor. For more information, see the dedicated documentation.

After cross-device reconciliation is enabled, calling GetRemoteVisitorData() with the parameter userId retrieves all known data for a given user.

Sessions with the same identifier will always be shown the same variation in an experiment. In the Visitor view of your experiment’s results pages, these sessions will appear as a single visitor.

The SDK configuration ensures that associated sessions always see the same variation of the experiment. However, there are some limitations regarding cross-device variation allocation. These limitations are outlined here.

Follow the activating cross-device history reconciliation guide to set up your custom data on the Kameleoon platform.

Afterwards, you can use the SDK normally. The following methods that may be helpful in the context of session merging:

• GetRemoteVisitorData() with added UniqueIdentifier(true) - to retrieve data for all linked visitors.
• TrackConversion() or Flush() with added UniqueIdentifier(true) data - to track some data for specific visitor that is associated with another visitor.

As the custom data you use as the identifier must be set to Visitor scope, you need to use cross-device custom data synchronization to retrieve the identifier with the GetRemoteVisitorData() method on each device.

Here’s an example of how to use custom data for session merging.

// In this example, `91` represents the index of the Custom Data
// configured as a unique identifier in Kameleoon.
const int MappingIndex = 91;
const string FeatureKey = "ff123";

// 1. Before the visitor is authenticated

// Retrieve the variation for an unauthenticated visitor.
// Assume `anonymousVisitorCode` is the randomly generated ID for that visitor.
Variation anonymousVariation = kameleoonClient.GetVariation(anonymousVisitorCode, FeatureKey);

// 2. After the visitor is authenticated

// Assume `userId` is the visitor code of the authenticated visitor.
kameleoonClient.AddData(anonymousVisitorCode, new CustomData(MappingIndex, userId));
kameleoonClient.Flush(anonymousVisitorCode, instant=true);

// Indicate that `userId` is a unique identifier.
kameleoonClient.AddData(userId, new UniqueIdentifier(true));

// 3. After the visitor has been authenticated

// Retrieve the variation for the `userId`, which will match the anonymous visitor code's variation.
Variation userVariation = kameleoonClient.GetVariation(userId, FeatureKey);
bool isSameVariation = userVariation.Key == anonymousVariation.Key; // true

// The `userId` and `anonymousVisitorCode` are now linked and tracked as a single visitor.
kameleoonClient.TrackConversion(userId, 123, 10.0);

// Additionally, the linked visitors will share all fetched remote visitor data.
await kameleoonClient.GetRemoteVisitorData(userId);

In this example, the application has a login page. Since the user ID is unknown at the moment of login, an anonymous visitor identifier generated by the GetVisitorCode() method is used. After the user logs in, the anonymous visitor is associated with the user ID and used as a unique identifier for the visitor.

Using a custom bucketing key

By default, Kameleoon uses a unique, anonymous visitor ID (visitorCode) to assign users to feature flag variations. This ID is typically generated and stored on the user’s device (in a browser cookie for client-side and server-side SDKs—in persistent storage for mobile SDKs). However, in certain scenarios you may need to ensure all users of the same organization see the same variant of a feature flag.

The Custom Bucketing Key option allows you to override this default behavior by providing your own custom identifier for bucketing. This override ensures that Kameleoon’s assignment logic uses your specified key instead of the default visitorCode.

Use cases

Using a custom bucketing key is essential for maintaining consistency and accuracy in your feature flag assignments, particularly in these situations:

• Account-level or organizational experiments: For B2B products or scenarios where you want to assign all users from the same organization to the same variation, you can use an identifier like an accountId. Custom bucketing keys are crucial for A/B testing features that impact an entire team or company.

By implementing a custom bucketing key, you ensure greater consistency and accuracy in your experiments, leading to more reliable results and a better user experience.

Technical details

When you configure a custom bucketing key for a feature flag, you provide Kameleoon with a specific identifier from your application’s data:

kameleoonClient.AddData(visitorCode, new CustomData(index, "newVisitorCode"));

• Providing the custom key: You provide your custom identifier to the Kameleoon SDK using the AddData() method. In this method, you will pass your chosen custom bucketing key as a CustomData object. Here, newVisitorCode refers to the identifier you wish to use for your bucketing (for example, the new userId or accountId).

For the custom bucketing key to function correctly, it must also be defined and configured for the feature flag during the flag creation or editing process. Without this corresponding configuration, the SDK’s bucketing will not apply your custom key. For detailed instructions on how to set this up in Kameleoon, refer to this article.

• Bucketing logic: Once a custom bucketing key is provided through the AddData() method, all hash calculations for assigning users to variations will use this newVisitorCode (your custom key) instead of the default visitorCode. Using the newVisitorCode means that the bucketing decision is tied to your custom identifier, ensuring consistent assignments across various contexts where that identifier is present.
• Data tracking and analytics: It’s crucial to note that while the newVisitorCode (your custom key) is used for bucketing decisions, all subsequent data (tracking events and conversions, for example) is sent and associated with the original visitorCode. This separation ensures that your analytics accurately reflect individual user journeys and interactions within your experiment’s broader context, even when bucketing is performed at a higher level (like an account) or across multiple devices/sessions. Your original visitor data remains intact for comprehensive reporting.

Technical requirements

To effectively use a custom bucketing key:

• The key must be a string.
• It must be unique for the entity you intend to bucket (for example, if using a userId, each user’s ID should be unique).
• The key must be available to the SDK at the exact moment the feature flag decision is evaluated for that user or request.

Targeting conditions

The Kameleoon SDKs support a variety of predefined targeting conditions that you can use to target users in your campaigns. For the list of conditions this SDK supports, see use visit history to target users.

You can also use your own external data to target users.

Logging

The SDK generates logs to reflect various internal processes and issues.

Log levels

The SDK supports configuring limiting logging by a log level.

// The `None` log level does not allow logging.
Kameleoon.Logging.KameleoonLogger.LogLevel = Kameleoon.Logging.LogLevel.None;

// The `Error` log level only allows logging issues that may affect the SDK's primary behavior.
Kameleoon.Logging.KameleoonLogger.LogLevel = Kameleoon.Logging.LogLevel.Error;

// The `Warning` log level allows logging issues which may require additional attention.
// It extends the `Error` log level.
// The `Warning` log level is a default log level.
Kameleoon.Logging.KameleoonLogger.LogLevel = Kameleoon.Logging.LogLevel.Warning;

// The `Info` log level allows logging general information on the SDK's internal processes.
// It extends the `Warning` log level.
Kameleoon.Logging.KameleoonLogger.LogLevel = Kameleoon.Logging.LogLevel.Info;

// The `DEBUG` level logs additional details about the SDK’s internal processes and extends the `INFO` level
// with more granular diagnostic output.
// This information is not intended for end-user interpretation but can be sent to our support team
// to assist with internal troubleshooting.
Kameleoon.Logging.KameleoonLogger.LogLevel = Kameleoon.Logging.LogLevel.Debug;

Custom handling of logs

The SDK writes its logs to the console output by default. This behaviour can be overridden.

Logging limiting by a log level is performed apart from the log handling logic.

class CustomLogger : Kameleoon.Logging.ILogger
{
    private readonly Microsoft.Extensions.Logging.ILogger inner;

    public CustomLogger(Microsoft.Extensions.Logging.ILogger inner)
    {
        this.inner = inner;
    }

    // `Log` method accepts logs from the SDK
    public void Log(Kameleoon.Logging.LogLevel level, string message)
    {
        // Custom log handling logic here. For example:
        switch (level)
        {
            case Kameleoon.Logging.LogLevel.Error:
                Microsoft.Extensions.Logging.LoggerExtensions.LogError(inner, message);
                break;
            case Kameleoon.Logging.LogLevel.Warning:
                Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(inner, message);
                break;
            case Kameleoon.Logging.LogLevel.Info:
                Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(inner, message);
                break;
            case Kameleoon.Logging.LogLevel.Debug:
                Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(inner, message);
                break;
        }
    }
}

// Log level filtering is applied separately from log handling logic.
// The custom logger will only accept logs that meet or exceed the specified log level.
// Ensure the log level is set correctly.
Kameleoon.Logging.KameleoonLogger.LogLevel = Kameleoon.Logging.LogLevel.Debug; // Optional; defaults to `LogLevel.Warning`.
Kameleoon.Logging.KameleoonLogger.Logger = new CustomLogger();

Reference

This is the full reference documentation of the C# SDK.

Initialization

Create()

To start using the SDK, you need to initialize it. Your app interacts with the SDK through the KameleoonClient class found in Kameleoon.IKameleoonClient. You can create this object using the static method Kameleoon.KameleoonClientFactory Create().

using Kameleoon;

string siteCode = "a8st4f59bj";

try {
    // Read from default configuration path: "/etc/kameleoon/client-csharp.conf"
    IKameleoonClient kameleoonClient = KameleoonClientFactory.Create(siteCode);
} catch (KameleoonException.SiteCodeIsEmpty e) {
    // indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
    // indicates that provided clientId / clientSecret are not valid
}

try {
    IKameleoonClient kameleoonClient = KameleoonClientFactory.Create(siteCode, "custom/file/path/client-csharp.conf");
} catch (KameleoonException.SiteCodeIsEmpty e) {
    // indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
    // indicates that provided clientId / clientSecret are not valid
}

try {
    KameleoonClientConfig config = new KameleoonClientConfig(
        clientId: "<clientId>", // mandatory
        clientSecret: "<clientId>", // mandatory
        refreshIntervalMinute: 60, // in minutes, optional (60 minutes by default)
        sessionDurationMinute: 30, // in minutes, optional (30 minutes by default)
        defaultTimeoutMillisecond: 10_000, // in milliseconds, optional (10000 ms by default)
        trackingIntervalMilliseconds: 1000, // in milliseconds, optional (1000 ms by default)
        environment: "development", // optional
        topLevelDomain: "example.com", // mandatory if you use hybrid mode (engine or web experiments)
        proxyHost: "proxy.host.com" // optional
        networkDomain: "example.com", // optional
    );
    IKameleoonClient kameleoonClient = KameleoonClientFactory.Create(siteCode, config);
} catch (KameleoonException.SiteCodeIsEmpty e) {
    // indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
    // indicates that provided clientId / clientSecret are not valid
}

Parameters

Name	Type	Description	Default
siteCode required	string	This is a unique key of the Kameleoon project you are using with the SDK.
configurationFilePath optional	string	Path to the SDK configuration file.	/etc/kameleoon/client-csharp.conf
kameleoonConfig optional	KameleoonClientConfig	Configuration SDK object that you can pass instead of using a configuration file.	null

Return value

Type	Description
IKameleoonClient	An instance of the KameleoonClient class, that will be used to manage your experiments and feature flags.

Exceptions thrown

Type	Description
KameleoonException.ConfigCredentialsInvalid	Exception indicating that the requested credentials were not provided in the configuration file or as arguments on the method.
KameleoonException.SiteCodeIsEmpty	Exception indicating that the specified site code is empty string which is invalid value.

WaitInit()

WaitInit() awaits the initialization of the Kameleoon client. This method allows you to verify that the client has successfully initialized before you proceed with other operations.

using static Kameleoon;

try {
    await kameleoonClient.WaitInit();
} catch (Exception exception) {
    //  indicates that client could not be initialized due to the thrown exception.
}

Return value

Type	Description
Task	The task will complete when the client has been successfully initialized.

Exceptions thrown

Type	Description
Exception	Exception indicating that client is not initialized properly and cannot be used yet.

Feature flags and variations

IsFeatureActive()

• 📨 Sends Tracking Data to Kameleoon (depending on the track parameter)

This method was previously called ActivateFeature, which was removed in SDK version 4.0.0.

To activate a feature toggle, call the IsFeatureActive method.

This method requires a visitorCode and a featureKey (or featureID) to check if a user can access a specific feature.

If the user has never been linked to this feature, the SDK will randomly decide whether to activate it, returning either true (the user can access the feature) or false (the user cannot). If the user with the given visitorCode is already linked to this feature, the system will return the previous value of the featureFlag.

Make sure to include proper error handling in your code, as shown in the example, to catch any potential errors.

If you specify a visitorCode, the IsFeatureActive() method uses it as the unique visitor identifier, which is useful for cross-device experimentation. When you specify a visitorCode and set the isUniqueIdentifier parameter to true, the SDK links the flushed data with the visitor associated with the specified identifier.

The parameter isUniqueIdentifier is deprecated. Please use UniqueIdentifier instead.

The isUniqueIdentifier can be helpful in unique situations; for example, if you cannot access the anonymous visitorCode given to a visitor, but you can use an internal ID linked to that visitor through session merging.

Kameleoon uses tracking to count sessions and visitors when you call certain methods, such as IsFeatureActive(), GetVariation() or GetVariations().

Use the default true value for the track parameter when you expose visitors to a variation and need to count them. Set the track parameter to false only if you call these methods before you expose visitors.

For example, if you call GetVariations() to retrieve all variations before you expose visitors, set the track parameter to false. This setting prevents Kameleoon from prematurely counting a session. You can then trigger tracking later when you explicitly expose the visitor.

Kameleoon sends tracking data every second by default. You can configure this interval up to five seconds using the tracking interval configuration option. Kameleoon groups tracking events into a single session as long as the interval between events is less than 30 minutes. If more than 30 minutes elapse between tracking events, Kameleoon counts the events as separate sessions. A visit appears in your reports 30 minutes after the last recorded event in the session.

string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, "example.com");
string featureKey = "new_checkout";
bool hasNewCheckout = false;

try {
  hasNewCheckout = kameleoonClient.IsFeatureActive(visitorCode, featureKey);
  // disabling tracking
  hasNewCheckout = kameleoonClient.IsFeatureActive(visitorCode, featureKey, track: false);
}
catch (KameleoonException.FeatureNotFound e) {
  // Feature toggle not yet activated on Kameleoon's side - we consider the feature inactive.
  hasNewCheckout = false;
}
catch (Exception e) {
  // This is a generic Exception handler which will handle all exceptions.
  Console.WriteLine("Exception occurred");
}
if (hasNewCheckout)
{
  // Implement new checkout code here.
}

The IsFeatureActive() method evaluates the served variant, not the master flag state. If you exclude rules, the method uses the Then, for everyone else serve default state. If you select Off for this default state, the method always returns false even when the master feature flag is On.

Parameters

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
featureKey	string	Key of the feature you want to expose to a user. This field is mandatory.
isUniqueIdentifier (Deprecated)	bool	An optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.
track	bool	An optional parameter to enable or disable tracking of the feature evaluation (true by default).

Return value

Type	Description
bool	Value of the feature that is registered for a given visitorCode.

Exceptions thrown

Type	Description
KameleoonException.VisitorCodeInvalid	Exception indicating that the specified visitor code is not valid. (It is either empty or longer than 255 characters).
KameleoonException.FeatureNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon’s side (but code implementing the feature is already deployed on the web-application’s side).

GetVariation()

• 📨 Sends Tracking Data to Kameleoon (depending on the track parameter)

Retrieves the Variation assigned to a given visitor for a specific feature flag.

This method takes a visitorCode and featureKey as mandatory arguments. The track argument is optional and defaults to true.

It returns the assigned Variation for the visitor. If the visitor is not associated with any feature flag rules, the method returns the default Variation for the given feature flag.

Ensure that proper error handling is implemented in your code to manage potential exceptions.

The default variation refers to the variation assigned to a visitor when they do not match any predefined delivery rules for a feature flag. In other words, it is the fallback variation applied to all users who are not targeted by specific rules. It’s represented as the variation in the “Then, for everyone else…” section in a management interface.

const string featureKey = "new_checkout";
Variation variation;

try
{
  variation = kameleoonClient.GetVariation(visitorCode, featureKey);
  // disabling tracking
  variation = kameleoonClient.GetVariation(visitorCode, featureKey, false);
} catch (KameleoonException.FeatureNotFound e)
{
  // The error has occurred; the feature flag isn't found in the current configuration.
} catch (KameleoonException.FeatureEnvironmentDisabled e)
{
  // The feature flag is disabled for the environment.
} catch (KameleoonException.VisitorCodeInvalid e)
{
  // The visitor code you passed to the method is invalid and can't be accepted by SDK.
}

// Fetch a variable value for the assigned variation.
string title = variation.Variables["title"].Value;

switch (variation.Key)
{
  case "on":
    // Main variation key is selected for visitorCode.
    break;
  case "alternative_variation":
    // Alternative variation key
    break;
  default:
    // Default variation key
    break;
}

Parameters

Name	Type	Description	Default
visitorCode required	string	Unique identifier of the visitor.
featureKey required	string	Key of the feature you want to expose to a visitor.
track optional	bool	An optional parameter to enable or disable tracking of the feature evaluation.	true

Return value

Type	Description
Variation	An assigned Variation to a given visitor for a specific feature flag.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.
FeatureNotFound	Exception indicating that the requested feature key wasn’t found in the internal configuration of the SDK. This usually means that the feature flag is not activated in the Kameleoon app (but code implementing the feature is already deployed in the application).
FeatureEnvironmentDisabled	Exception indicating that feature flag is disabled for the visitor’s current environment (for example, production, staging, or development).

GetVariations()

• 📨 Sends Tracking Data to Kameleoon (depending on the track parameter)

Retrieves a map of Variation objects assigned to a given visitor across all feature flags.

This method iterates over all available feature flags and returns the assigned Variation for each flag associated with the specified visitor. It takes visitorCode as a mandatory argument, while onlyActive and track are optional.

• If onlyActive is set to true, the method GetVariations() will return feature flags variations provided the user is not bucketed with the off variation.
• The track parameter controls whether or not the method will track the variation assignments. By default, it is set to true. If set to false, the tracking will be disabled.

The returned map consists of feature flag keys as keys and their corresponding Variation as values. If no variation is assigned for a feature flag, the method returns the default Variation for that flag.

Proper error handling should be implemented to manage potential exceptions.

The default variation refers to the variation assigned to a visitor when they do not match any predefined delivery rules for a feature flag. In other words, it is the fallback variation applied to all users who are not targeted by specific rules. It’s represented as the variation in the “Then, for everyone else…” section in a management interface.

IReadOnlyDictionary<string, Types.Variation> variations;
try
{
    variations = kameleoonClient.GetVariations(visitorCode);
    // only active variations
    variations = kameleoonClient.GetVariations(visitorCode, true);
    // disable tracking
    variations = kameleoonClient.GetVariations(visitorCode, track: false);
}
catch (VisitorCodeInvalid e)
{
    //  Handle exception
}

Parameters

Name	Type	Description	Default
visitorCode required	string	Unique identifier of the visitor.
onlyActive optional	bool	An optional parameter indicating whether to return variations for active (true) or all (false) feature flags.	false
track optional	bool	An optional parameter to enable or disable tracking of the feature evaluation.	true

Return value

Type	Description
IReadOnlyDictionary<string, Variation>	Map that contains the assigned Variation objects of the feature flags using the keys of the corresponding features.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

GetFeatureList()

This method was previously named ObtainFeatureList(), which was removed in SDK version 4.0.0.

Returns a list of feature flag keys currently available for the SDK.

const featureFlagIds = kameleoonClient.GetFeatureList()

Return value

Type	Description
List<string>	List of feature flag keys

SetForcedVariation()

The method allows you to programmatically assign a specific Variation to a user, bypassing the standard evaluation process. This is especially valuable for controlled experiments where the usual evaluation logic is not required or must be skipped. It can also be helpful in scenarios like debugging or custom testing.

When a forced variation is set, it overrides Kameleoon’s real-time evaluation logic. Processes like segmentation, targeting conditions, and algorithmic calculations are skipped. To preserve segmentation and targeting conditions during an experiment, set forceTargeting=false instead.

Simulated variations always take precedence in the execution order. If a simulated variation calculation is triggered, it will be fully processed and completed first.

A forced variation is treated the same as an evaluated variation. It is tracked in analytics and stored in the user context like any standard evaluated variation, ensuring consistency in reporting.

The method may throw exceptions under certain conditions (e.g., invalid parameters, user context, or internal issues). Proper exception handling is essential to ensure that your application remains stable and resilient.

It’s important to distinguish forced variations from simulated variations:

• Forced variations: Are specific to an individual experiment.
• Simulated variations: Affect the overall feature flag result.

const int experimentId = 9516;
try
{
    // Forcing the variation "on" in the experiment 9516 for the visitor
    kameleoonClient.SetForcedVariation(visitorCode, experimentId, "on");

    // Forcing the variation "on" while preserving segmentation and targeting conditions during the experiment
    kameleoonClient.SetForcedVariation(visitorCode, experimentId, "on", false);

    // Resetting the forced variation for the experiment 9516 for the visitor
    kameleoonClient.SetForcedVariation(visitorCode, experimentId, null);
}
catch (KameleoonException ex)
{
    // Handling the exception
}

Parameters

Name	Type	Description	Default
visitorCode required	string	Unique identifier of the visitor.
experimentId required	int	Experiment Id that will be targeted and selected during the evaluation process.
variationKey required	string	Variation Key corresponding to a Variation that should be forced as the returned value for the experiment. If the value is null, the forced variation will be reset.
forceTargeting optional	bool	Indicates whether targeting for the experiment should be forced and skipped (true) or applied as in the standard evaluation process (false).	true

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.
FeatureExperimentNotFound	Exception indicating that the requested experiment id has not been found in the SDK’s internal configuration. This is usually normal and means that the rule’s corresponding experiment has not yet been activated on Kameleoon’s side.
FeatureVariationNotFound	Exception indicating that the requested variation key(id) has not been found in the internal configuration of the SDK. This is usually normal and means that the variation’s corresponding experiment has not yet been activated on Kameleoon’s side.

In most cases, only the basic error, KameleoonException, needs to be handled, as demonstrated in the example. However, if different types of errors require a response, handle each one separately based on specific requirements. Additionally, for enhanced reliability, general language errors can be handled by including Exception.

EvaluateAudiences()

• 📨 Sends Tracking Data to Kameleoon

This method evaluates visitors against all available Audiences Explorer segments and tracks those who match.

EvaluateAudiences() should be called after all relevant visitor data has been set or updated, and just before getting a feature variation or checking a feature flag. This approach ensures that the visitor is evaluated against the most current data available, allowing for accurate audience assignment based on all criteria.

After calling this method, you can perform a detailed analysis of segment performance in Audiences Explorer.

try
{
    kameleoonClient.EvaluateAudiences(visitorCode);
}
catch (KameleoonException ex)
{
    // Handling the exception
}

Parameters

Name	Type	Description
visitorCode required	string	Unique identifier of the visitor.

Exceptions thrown

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

In most cases, only the basic error, KameleoonException, needs to be handled, as demonstrated in the example. However, if different types of errors require a response, handle each one separately based on specific requirements. Additionally, for enhanced reliability, general language errors can be handled by including Exception.

GetDataFile()

DataFile dataFile = kameleoonClient.GetDataFile();

Return value

Visitor data

GetVisitorCode()

This method was previously called ObtainVisitorCode, which was removed in SDK version 4.0.0.

To get the Kameleoon visitorCode for the current visitor, use the GetVisitorCode() method. This method is crucial in environments where front-end and back-end systems must consistently identify users. Here’s how it works:

1. Check for a kameleoonVisitorCode cookie or query parameter in the current HTTP request. If you find one, use that as the visitor identifier and skip the next step.

2. If you don’t find a cookie or parameter, either randomly create a new identifier or use the defaultVisitorCode argument if it’s provided. Doing so lets you use your identifiers as visitor codes, making connecting Kameleoon visitors to your own users easier without needing extra look-ups.

3. Set the server-side kameleoonVisitorCode cookie using the identifier value. The method returns this identifier value.

If you provide your own visitorCode, make sure it is unique! Also note that the length of visitorCode is limited to 255 characters. Using an identifier with too many characters will result in an exception.

The GetVisitorCode() method allows you to set simulated variations for a visitor. When cookies (from a request or document) contain the key kameleoonSimulationFFData, the standard evaluation process is bypassed. Instead, the method directly returns a Variation based on the provided data.

You can apply simulations in two ways:

• Automatically (recommended): If using Kameleoon Web Experimentation or the SDK in Hybrid mode, the cookie is created automatically when simulating a variant’s display using the Simulation Panel.
• Manually: Set the kameleoonSimulationFFData cookie manually.

It’s important to distinguish simulated variations from forced variations:

• Simulated variations: Affect the overall feature flag result.
• Forced variations: Are specific to an individual experiment.

⚙️ Manual setup

Please ensure the kameleoonSimulationFFData cookie follows this format:

• kameleoonSimulationFFData={"featureKey":{"expId":10,"varId":20}}: Simulates the variation with varId of experiment expId for the given featureKey.
• kameleoonSimulationFFData={"featureKey":{"expId":0}}: Simulates the default variation (defined in the Then, for everyone else in Production, serve section) for the given featureKey.

⚠️ To ensure proper functionality, the cookie value must be encoded as a URI component using a method such as encodeURIComponent.

try
{
    string visitorCode = kameleoonClient.GetVisitorCode(Request, Response);

    string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, defaultVisitorCode);
}
catch (VisitorCodeInvalid e)
{
    //  Handle exception
}

Parameters

Name	Type	Description
Request	Microsoft.AspNetCore.Http.HttpRequest / System.Web.HttpRequest	The current Request object should be passed as the first parameter. This field is mandatory.
Response	Microsoft.AspNetCore.Http.HttpResponse / System.Web.HttpResponse	The current Response object should be passed as the second parameter. This field is mandatory.
defaultVisitorCode	string	This parameter will be used as the visitorCode if no existing kameleoonVisitorCode cookie is found on the request. This field is optional, and by default a random visitorCode will be generated.

Return value

Type	Description
string	A visitorCode that will be associated with this particular user and should be used with most of the methods of the SDK.

Exceptions thrown

Type	Description
KameleoonException.VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid (it is either empty or longer than 255 characters).

AddData()

The AddData() method adds targeting data to storage so other methods can use the data to decide whether or not to target the current visitor.

The AddData() method does not return any value and does not interact with Kameleoon back-end servers on its own. Instead, all the declared data is saved for future transmission using the Flush() method. This approach reduces the number of server calls made, as the data is typically grouped into a single server call that is triggered by the Flush().

The TrackConversion() method also sends out any previously associated data, just like the Flush(). The same holds true for GetVariation() and GetVariations() methods if an experimentation rule is triggered.

Each visitor can only have one instance of associated data for most data types. However, CustomData is an exception. Visitors can have one instance of associated CustomData per index.

// Add a single data item (tracked by default)
kameleoonClient.AddData(new Browser(Browser.Browsers.CHROME));

// Add multiple data items (tracked by default)
kameleoonClient.AddData(
    visitorCode,
    new PageView("https://url.com", "title", new int[] {3}),
    new UserAgent("UserAgent")
);

// Add multiple data items stored locally for targeting only (not sent to the Kameleoon Data API)
kameleoonClient.AddData(
    visitorCode,
    false,
    new PageView("https://url.com", "title", new int[] {3}),
    new UserAgent("UserAgent")
);

Parameters

Name	Type	Description	Default value
visitorCode required	string	Unique identifier of the visitor.
track optional	bool	Specifies whether the added data is eligible for tracking. When set to false, the data is stored locally and used only for targeting evaluation; it is not sent to the Kameleoon Data API.	true
data required	params IData[]	Collection of Kameleoon data types.

Exceptions

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

Flush()

• 📨 Sends Tracking Data to Kameleoon

The Flush() method collects the Kameleoon data linked to the visitor. It then sends a tracking request along with all the previously added data using the AddData method, which has not yet been sent using one of these methods. Flush() is non-blocking as the server call is made asynchronously.

Flush() lets you control when the data associated with a given visitorCode is sent to our servers. For instance, if you call AddData() a dozen times, it would be inefficient to send data to the server after each time AddData() is invoked, so all you have to do is call Flush() once at the end.

If you specify a visitorCode, the Flush() method uses it as the unique visitor identifier, which is useful for cross-device experimentation. When you specify a visitorCode and set the isUniqueIdentifier parameter to true, the SDK links the flushed data with the visitor associated with the specified identifier.

The parameter isUniqueIdentifier is deprecated. Please use UniqueIdentifier instead.

The isUniqueIdentifier can be helpful in unique situations; for example, if you cannot access the anonymous visitorCode given to a visitor, but you can use an internal ID linked to that visitor through session merging.

string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, "example.com");

kameleoonClient.AddData(new Browser(Browser.Browsers.CHROME));
kameleoonClient.AddData(
    visitorCode,
    new PageView("https://url.com", "title", new int[] {3}),
    new Conversion(32, 10f, false)
);

kameleoonClient.Flush(visitorCode); // Interval tracking (most performant tracking method)

kameleoonClient.Flush(true, visitorCode); // Instant tracking

// if you operate with unique ID
kameleoonClient.AddData(visitorCode, new UniqueIdentifier(true));
kameleoonClient.Flush(visitorCode);

Parameters

Name	Type	Description
instant	bool	Boolean flag indicating whether the data should be sent instantly (true) or according to the scheduled tracking interval (false). This field is optional.
visitorCode	string	Unique identifier of the user. This field is mandatory.
isUniqueIdentifier (Deprecated)	bool	An optional parameter for specifying if the visitorCode is a unique identifier. The visitorCode should be provided and not null to apply isUniqueIdentifier for a visitor, otherwise it will be ignored. If not provided, the default value is false. The field is optional.

GetRemoteData()

This method was previously named RetrieveDataFromRemoteSource, which was removed in SDK version 4.0.0.

GetRemoteData() is a method that lets you fetch data for a specific siteCode (set in KameleoonClientFactory.create()) from a remote Kameleoon server using a key you provide. Our Data API stores this data on our servers, which are designed to efficiently handle large amounts of data. Keep in mind that because this method involves a server call, it works asynchronously.

var testValue = await kameleoonClient.GetRemoteData("test"); // default timeout
testValue = await kameleoonClient.GetRemoteData("test", 1000);
try {
  testValue = await kameleoonClient.GetRemoteData("test");
} catch (Exception e)  {
  // Timeout or Json Parsing Exception
}

Parameters

Name	Type	Description
key	string	The key that the data you try to get is associated with. This field is mandatory.
timeout	int?	Timeout (in milliseconds). This parameter specifies the maximum amount of time to wait for a result. This field is optional, if not provided, it will use the default value of 10000 milliseconds.

Return value

Type	Description
JObject	Data associated with retrieving data for specific key.

Exceptions thrown

Type	Description
Exception	Exception indicating that the request timed out or retrieved data can’t be parsed with JObject.Parse method.

GetRemoteVisitorData()

GetRemoteVisitorData() is a method that retrieves Kameleoon visit data for a specific user using their VisitorCode. It works in the background and stores this data for other methods to make targeting decisions.

This data is important for several reasons:

• It helps you use information collected from different devices.
• It allows you to access a user’s history, such as previously visited pages from earlier visits.
• It lets you use data only available on the client side, such as datalayer variables and goals that only track conversions on the front-end.

Read this article for a better understanding of possible use cases.

By default, GetRemoteVisitorData() automatically retrieves the latest stored custom data with Scope=Visitor and attaches them to the visitor without the need to call the method AddData(). It is particularly useful for synchronizing custom data between multiple devices.

The parameter isUniqueIdentifier is deprecated. Please use UniqueIdentifier instead.

The isUniqueIdentifier can be helpful in unique situations; for example, if you cannot access the anonymous visitorCode given to a visitor, but you can use an internal ID linked to that visitor through session merging.

string visitorCode = "visitorCode";
// Visitor data will be fetched and automatically added for `visitorCode`
Task<IReadOnlyCollection<IData>> visitorData = kameleoonClient.GetRemoteVisitorData(visitorCode);

// If you only want to fetch data and add it yourself manually, set addData == `false`.
Task<IReadOnlyCollection<IData>> visitorData = kameleoonClient.GetRemoteVisitorData(visitorCode, false);

// If you want to fetch custom list of data types
var filter = new RemoteVisitorDataFilter(25, customData: false, conversions: true, experiments: true);
var visitorData = kameleoonClient.getRemoteVisitorData(visitorCode, filter: filter);

try {
  IReadOnlyCollection<IData> visitorData = await kameleoonClient.GetRemoteVisitorData(visitorCode);
  // Your custom code
} catch (Exception e) {
  // Catch exception
}

Parameters

Name	Type	Description
visitorCode	string	The visitor code for which you want to retrieve the assigned data. This field is mandatory.
addData	bool	A boolean indicating whether the method should automatically add retrieved data for a visitor. This field is optional.
timeout	int?	Timeout (in milliseconds). This parameter specifies the maximum amount of time to wait for a result. This field is optional. If not provided, the default value is 10000 milliseconds.
filter	Kameleoon.Types.RemoteVisitorDataFilter	Filter for specifying what data should be retrieved from visits, by default only CustomData is retrieved from the current and latest previous visit (new RemoteVisitorDataFilter(previousVisitAmount: 1, currentVisit: true, customData: true) or RemoteVisitorDataFilter.Default). Other filters parameters are set to false. This field is optional.
isUniqueIdentifier (Deprecated)	bool	An optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.

Return value

Type	Description
Task<IReadOnlyCollection<IData>>	Collection associated with a given visitor.

Exceptions thrown

Type	Description
HttpRequestException	Exception indicating that the request was failed for any reason.
Exception	Exception indicating that the request timed out or any other reason of failure.

Using parameters in GetRemoteVisitorData()

The GetRemoteVisitorData() method offers flexibility by allowing you to define various parameters when retrieving data on visitors. Whether you’re targeting based on goals, experiments, or variations, the same approach applies across all data types.

For example, let’s say you want to retrieve data on visitors who completed a goal “Order transaction”. You can specify parameters within the GetRemoteVisitorData() method to refine your targeting. For instance, if you want to target only users who converted on the goal in their last five visits, you can set the PreviousVisitAmount parameter to 5 and Conversions to true.

The flexibility shown in this example is not limited to goal data. You can use parameters within the GetRemoteVisitorData() method to retrieve data on a variety of visitor behaviors.

Here is the list of available Kameleoon.Types.RemoteVisitorDataFilter options:

Name	Type	Description	Default
previousVisitAmount optional	int	Number of previous visits to retrieve data from. Number between 1 and 25	1
currentVisit optional	bool	If true, current visit data will be retrieved	true
customData optional	bool	If true, custom data will be retrieved.	true
pageViews optional	bool	If true, page data will be retrieved.	false
geolocation optional	bool	If true, geolocation data will be retrieved.	false
device optional	bool	If true, device data will be retrieved.	false
browser optional	bool	If true, browser data will be retrieved.	false
operatingSystem optional	bool	If true, operating system data will be retrieved.	false
conversions optional	bool	If true, conversion data will be retrieved.	false
experiments optional	bool	If true, experiment data will be retrieved.	false
kcs optional	bool	If true, Kameleoon Conversion Score (KCS) will be retrieved. Requires the AI Predictive Targeting add-on.	false
visitorCode optional	bool	If true, the visitorCode from the most recent visit should be retrieved and applied to the current visitor. Required for Cross-device experimentation.	true
cbs optional	bool	If true, Contextual Bandit score data will be retrieved.	false

GetVisitorWarehouseAudience()

This method retrieves all audience data associated with the visitor in your data warehouse using the specified visitorCode and warehouseKey. The warehouseKey is typically your internal user ID. The customDataIndex parameter corresponds to the Kameleoon custom data that Kameleoon uses to target your visitors. You can refer to the warehouse targeting documentation for additional details. The method returns a CustomData object, confirming that the data has been added to the visitor and is available for targeting purposes.

Task<CustomData> warehouseAudienceDataTask = kameleoonClient.
  GetVisitorWarehouseAudience(visitorCode, customDataIndex); // default timeout
Task<CustomData> warehouseAudienceDataTask = kameleoonClient.
  GetVisitorWarehouseAudience(visitorCode, customDataIndex, timeout: 1000);

// If you need to specify warehouse key
Task<CustomData> warehouseAudienceDataTask = kameleoonClient.
  GetVisitorWarehouseAudience(visitorCode, customDataIndex, warehouseKeyValue); // default timeout
Task<CustomData> warehouseAudienceDataTask = kameleoonClient.
  GetVisitorWarehouseAudience(visitorCode, customDataIndex, warehouseKeyValue, 1000);

try
{
  CustomData warehouseAudienceData = await warehouseAudienceDataTask;
  // Your custom code
}
catch (Exception e)
{
  // Catch exception
}

Parameters

Name	Type	Description
visitorCode	string	A unique visitor identification string, can’t exceed 255 characters length.
customDataIndex	int	An integer representing the index of the custom data you want to use to target your BigQuery Audiences.
warehouseKey	string	A unique key to identify the warehouse data (usually, your internal user ID). This field is optional.
timeout	int?	Timeout (in milliseconds). This parameter specifies the maximum amount of time to wait for a result. This field is optional. If not provided, the default value is 10000 milliseconds.

Return value

Type	Description
Task<CustomData>	A CustomData instance confirming that the data has been added to the visitor.

Exceptions thrown

Type	Description
KameleoonException.VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid (it is either empty or longer than 255 characters).
HttpRequestException	Exception indicating that the request was failed for any reason.
Exception	Exception indicating that the request timed out or any other reason of failure.

SetLegalConsent()

You must use this method to specify whether the visitor has given legal consent to use personal data. Setting the legalConsent parameter to false limits the types of data that you can include in tracking requests. This method helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information on personal data in the consent management policy.

string visitorCode = kameleoonClient.GetVisitorCode(httpRequest, httpResponse);
kameleoonClient.SetLegalConsent(visitorCode, true, httpResponse);

Parameters

Name	Type	Description
visitorCode	string	The user’s unique identifier. This field is required.
legalConsent	bool	A boolean value representing the legal consent status. true indicates the visitor has given legal consent, false indicates the visitor has never provided, or has withdrawn, legal consent. This field is required.
response	Microsoft.AspNetCore.Http.HttpResponse / System.Web.HttpRequest	The HTTP response where values in the cookies will be adjusted based on the legal consent status. This field is optional.

Exceptions thrown

Type	Description
KameleoonException.VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

Consent revocation behavior

When you call setLegalConsent() with consent=false, the SDK does not delete the kameleoonVisitorCode cookie. Instead, it stops extending the cookie’s expiration date, allowing the cookie to persist until it naturally expires.

If your compliance requirements demand the immediate removal of the cookie file upon opt-out, you must delete it manually using your framework’s native cookie management methods. The SDK will not remove the file automatically.

Goals and third-party analytics

TrackConversion()

• 📨 Sends Tracking Data to Kameleoon

Use this method to track a conversion for a specific goal and user. This method requires visitorCode and goalId. In addition, this method also accepts an optional revenue, negative and metadata arguments. The visitorCode is usually identical to the one that was used when triggering the experiment.

The TrackConversion() method doesn’t return any value. This method is non-blocking as the server call is made asynchronously.

The parameter isUniqueIdentifier is deprecated. Please use UniqueIdentifier instead.

The isUniqueIdentifier can also be useful in other edge-case scenarios, such as when you can’t access the anonymous visitorCode that was originally assigned to the visitor, but you do have access to an internal ID that is connected to the anonymous visitor using session merging capabilities.

using Kameleoon;

string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, "example.com");
int goalId = 83023;

kameleoonClient.TrackConversion(visitorCode, goalId);

// Add metadata
var cd = new CustomData(1, "metadata");
kameleoonClient.TrackConversion(visitorCode, goalId, metadata: cd)

Parameters

Name	Type	Description	Default
visitorCode required	string	Unique identifier of the visitor.
goalId required	int	ID of the goal.
revenue optional	float?	Revenue of the conversion.	0
negative optional	bool	Defines if the revenue is positive or negative.	false
metadata optional	params CustomData[]	Lets you set specific values for custom data which have been defined as metadata for the goal in the Kameleoon App. Example: [CustomData{id: 5, value: "Payment Type"}, CustomData{id: 6, value: "Delivery Method"}]. In this example, 5 and 6 are the indexes of the custom data (5 = “Payment Type”, 6 = “Delivery Method”).	new CustomData[0]
isUniqueIdentifier (deprecated)	bool	An optional parameter for specifying if the visitorCode is a unique identifier.	false

metadata values are accessible through raw data exports and the results page.

If the metadata parameter is provided, Kameleoon will use these specified values for the current conversion instead of what was previously collected using the AddData() method. If the parameter is omitted, Kameleoon will use the last tracked values for those CustomData prior to the conversion and within the same visit.

Kameleoon will only consider the metadata values that are explicitly passed as parameters to the TrackConversion() method.

In the example below, Kameleoon will associate the conversion only with the custom data value explicitly provided as a parameter (here: index 5 with the value ‘Amex Credit Card’).

kameleoonClient.AddData(visitorCode, new CustomData(5, "Credit Card"), new CustomData(9, "Express Delivery"));
kameleoonClient.TrackConversion(visitorCode, 10, metadata: new CustomData(5, "Amex Credit Card"));

Exceptions

Type	Description
VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

GetEngineTrackingCode()

Kameleoon integrates with several analytics solutions, including Mixpanel, Google Analytics 4, and Segment. To track server-side experiments correctly, call the GetEngineTrackingCode() method after the visitor triggers an experiment. The SDK returns JavaScript queue commands for the experiments that the visitor triggered during the previous five seconds. When you insert this code into the page, Engine.js processes the commands and sends the exposure events through the active analytics integration.

Refer to hybrid experimentation for more information on implementing this method.

string engineTrackingCode = kameleoonClient.GetEngineTrackingCode(visitorCode);

• To use this feature, implement both the C# SDK and Kameleoon Engine.js. Because Engine.js is used only for tracking in this flow, you can install the asynchronous tag before the closing </body> tag.
• If you only want to track experiments in Kameleoon and do not need to send exposure events to third-party analytics tools, use the JavaScript / TypeScript SDK. This option works well for serverless edge compute platforms. The JavaScript / TypeScript SDK automatically tracks variations when you call getVisitorCode, as long as you add the corresponding experiment assignments to window.kameleoonQueue.
• You can insert the returned tracking code directly into an HTML <script> tag.

<html lang="en">
  <body>
    <script>
      const engineTrackingCode = `
        window.kameleoonQueue = window.kameleoonQueue || [];
        window.kameleoonQueue.push(['Experiments.assignVariation', 123456, 7890, true]);
        window.kameleoonQueue.push(['Experiments.trigger', 123456, true]);
        window.kameleoonQueue.push(['Experiments.assignVariation', 234567, 8901, true]);
        window.kameleoonQueue.push(['Experiments.trigger', 234567, true]);
      `;
      const script = document.createElement('script');

      script.textContent = engineTrackingCode;
      document.body.appendChild(script);
    </script>

  </body>
</html>

In this example, 123456 and 234567 are experiment IDs, and 7890 and 8901 are variation IDs. In your implementation, the SDK generates these values in the returned tracking code.

Parameters

Name	Type	Description
visitorCode required	string	Unique identifier of the visitor.

Return value

Type	Description
string	JavaScript code to insert into the page.

Events

UpdateConfigurationHandler()

The UpdateConfigurationHandler() method allows you to handle the event when configuration has updated data. It takes one input parameter, handler. The handler that will be called when the configuration is updated using a real-time configuration event.

kameleoonClient.UpdateConfigurationHandler(async delegate () {
  // Configuration was updated
});

Parameters

Name	Type	Description
handler	Action	The handler that will be called when the configuration is updated using a real-time configuration event.

Data types

Data available in the SDK is not available for targeting and reporting in the Kameleoon app until it is added; for example, by using the addData() method. See use visit history to target users for more information.

If you are in hybrid mode, you can call GetRemoteVisitorData() to automatically fill all data that Kameleoon collected previously.

The following data types are available in Kameleoon.Data.IData.

Browser

The Browser data set stored here can be used to filter experiment and personalization reports by any value associated with it.

Name	Type	Description
browser required	Browser.Browsers	List of browsers: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER.
version optional	float?	Version of the browser, floating point number represents major and minor version of the browser

kameleoonClient.AddData(visitorCode, new Browser(Browser.Browsers.CHROME));

kameleoonClient.AddData(visitorCode, new Browser(Browser.Browsers.SAFARI, 16));

PageView

Name	Type	Description
url	string	URL of the page viewed. This field is mandatory.
title	string	Title of the page viewed. This field is mandatory.
referrers	int[]	Referrers of viewed pages. This field is optional.

The index (ID) of the referrer is available in our Back-Office in the Acquisition channel configuration page. Be careful: this index starts at 0, so the first acquisition channel you create for a given site would have the ID 0, not 1.

kameleoonClient.AddData(
  visitorCode,
  new PageView("https://url.com", "title", new int[] {3})
);

Conversion

The Conversion data set stored here can be used to filter experiment and personalization reports by any goal associated with it.

• Each visitor can have multiple Conversion objects.
• You can find the goalId in the Kameleoon app.

Name	Type	Description	Default
goalId required	int	ID of the goal.
revenue optional	float	Revenue of the conversion	0
negative optional	bool	Defines if the revenue is positive or negative.	false
metadata optional	params CustomData[]	Metadata of the conversion.	new CustomData[0]

kameleoonClient.AddData(visitorCode, new Conversion(32, 10f));

kameleoonClient.AddData(visitorCode, new Conversion(33, negative: true));

kameleoonClient.AddData(
    visitorCode,
    new Conversion(34, 5f, metadata: new CustomData(3, "metadata1", "md2"), new CustomData(5, "md3"))
);

CustomData

CustomData allows any type of data to be easily associated with each visitor. It can then be used as a targeting condition in segments or as a filter/breakdown in experiment reports. To learn more about custom data, please refer to this article.

Name	Type	Description	Default
index/name required	int/string	Index or Name of the custom data. Either index or name must be provided to identify the data.
values required	params string[]	Values of the custom data to be stored.
overwrite optional	bool	Flag to explicitly control how the values are stored and how they appear in reports. See more	true

• Each visitor is allowed only one CustomData for each unique index. Adding another CustomData with the same index will replace the existing one.

• The custom data ‘index’ can be found in the Custom Data dashboard under the “INDEX” column.

• To prevent the SDK from sending data with the selected index to Kameleoon servers for privacy reasons, enable the option: Use this data only locally for targeting purposes when creating custom data.

• Adding a CustomData instance created with a name when the SDK instance configuration is not up to date or the name is not registered, will result in the data being ignored.

kameleoonClient.AddData(visitorCode, new CustomData(1, "value"));

// With several values
kameleoonClient.AddData(visitorCode, new CustomData(1, "value1", "value2"));

// To set the 'overwrite' flag to false
kameleoonClient.AddData(visitorCode, new CustomData(1, false, "value"));

// To use a name instead of the index
kameleoonClient.AddData(visitorCode, new CustomData("my-custom-data", "value"));

Device

Name	Type	Description
device	Device.Type	List of devices: PHONE, TABLET, DESKTOP. This field is mandatory.

kameleoonClient.AddData(visitorCode, new Device(Device.Type.DESKTOP));

UserAgent

Server-side experiments are more likely to be affected by bot traffic than client-side experiments. Kameleoon uses the IAB/ABC International Spiders and Bots List to tackle this issue and recognize known bots and spiders. Kameleoon also uses the UserAgent field to filter out bots and other unwanted traffic that might distort your conversion metrics. For more details, see our help article on bot filtering.

If you use internal bots, we suggest that you pass the value curl/8.0 of the userAgent to exclude them from our analytics.

Name	Type	Description
Value	string	The UserAgent value that will be sent with tracking requests. This field is mandatory.

kameleoonClient.AddData(visitorCode, new UserAgent("Your User Agent"));

UniqueIdentifier

If you don’t add UniqueIdentifier for a visitor, visitorCode is used as the unique visitor identifier, which is useful for Cross-device experimentation. When you add UniqueIdentifier for a visitor, the SDK links the flushed data with the visitor associated with the specified identifier.

The isUniqueIdentifier can be helpful in unique situations; for example, if you cannot access the anonymous visitorCode given to a visitor, but you can use an internal ID linked to that visitor through session merging.

Name	Type	Description
value	bool	Parameter for specifying if the visitorCode is a unique identifier. This field is required.

kameleoonClient.AddData(visitorCode, new UniqueIdentifier(true));

OperatingSystem

OperatingSystem contains information about the operating system on the visitor’s device.

Each visitor can only have one OperatingSystem. Adding a second OperatingSystem overwrites the first one.

Name	Type	Description
type	OperatingSystem.Type	List of operating systems: WINDOWS, MAC, IOS, LINUX, ANDROID and WINDOWS_PHONE. This field is required.

kameleoonClient.addData(visitorCode, new OperatingSystem(OperatingSystem.Type.WINDOWS));

Cookie

Cookie contains information about the cookie stored on the visitor’s device.

Name	Type	Description
cookies	IReadOnlyDictionary<string, string>	A string object map consisting of cookie keys and values. This field is required.

Each visitor can only have one Cookie. Adding a second Cookie overwrites the first one.

Cookie cookie = new Cookie (new Dictionary<string, string>() {
    { "k1", "v1" },
    { "k2", "v2" },
});
kameleoonClient.addData(visitorCode, cookie);

Geolocation

Geolocation contains the visitor’s geolocation details.

Name	Type	Description
country required	string	The country of the visitor.
region optional	string	The region of the visitor.
city optional	string	The city of the visitor.
postalCode optional	string	The postal code of the visitor.
latitude optional	float	The latitude coordinate representing the location of the visitor. Coordinate number represents decimal degrees.
longitude optional	float	The longitude coordinate representing the location of the visitor. Coordinate number represents decimal degrees.

• Each visitor can have only one Geolocation. Adding a second Geolocation overwrites the first one.

kameleoonClient.addData(visitorCode, new Geolocation("France", "Île-de-France", "Paris"));

ApplicationVersion

ApplicationVersion represents the semantic version number of your application.

A visitor can have only one ApplicationVersion. Adding a second instance will overwrite the first one.

Name	Type	Description
version optional	string	The mobile application version. This field must follow semantic versioning. Accepted formats are major, major.minor, or major.minor.patch.

client.AddData(visitorCode, new ApplicationVersion("10")) // major

client.AddData(visitorCode, new ApplicationVersion("10.20")) // major.minor

client.AddData(visitorCode, new ApplicationVersion("10.20.30")) // major.minor.patch

Returned Types

DataFile

The DataFile contains the SDK configuration details.

It can be extended with additional information if required by clients. If you need more details, please contact your Customer Success Manager.

Name	Type	Description
FeatureFlags	IReadOnlyDictionary<string, FeatureFlag>	A map of FeatureFlag objects, keyed by feature flag keys.
DateModified	long	The timestamp (in milliseconds) indicating when the DataFile was last modified.

// Retrieves the map of feature flags from the DataFile.
// The map is keyed by feature flag identifiers, with each value being a FeatureFlag object.
IReadOnlyDictionary<string, FeatureFlag> featureFlags = dataFile.FeatureFlags;

// Retrieves the last modification timestamp of the DataFile.
// The value is a long representing milliseconds since the Unix epoch.
long dateModified = dataFile.DateModified;

Variation

Variation contains information about the assigned variation to the visitor (or the default variation if no specific assignment exists).

Name	Type	Description
Key	string	The unique key identifying the variation.
Id	int	The ID of the assigned variation (or Variation.UndefinedId if it’s the default variation).
ExperimentId	int	The ID of the experiment associated with the variation (or Variation.UndefinedId if default).
Variables	IReadOnlyDictionary<string, Variable>	A dictionary containing the variables of the assigned variation, keyed by variable names. This could be an empty collection if no variables are associated.

• The Variation object provides details about the assigned variation and its associated experiment, while the Variable object contains specific details about each variable within a variation.
• Ensure that your code handles the case where Id or ExperimentId may be Variation.UndefinedId, indicating a default variation.
• The Variables dictionary might be empty if no variables are associated with the variation.

// Retrieving the variation key
string variationKey = variation.Key;

// Retrieving the variation id
int variationId = variation.Id;

// Retrieving the experiment id
int experimentId = variation.ExperimentId;

// Retrieving the variables map
var variables = variation.Variables;

Variable

Variable contains information about a variable associated with the assigned variation.

Name	Type	Description
Key	string	The unique key identifying the variable.
Type	string	The type of the variable. Possible values: BOOLEAN, NUMBER, STRING, JSON, JS, CSS.
Value	object	The value of the variable, which can be of the following types: bool, int, double, string, Newtonsoft.Json.Linq.JToken.

// Retrieving the variables map
var variables = variation.Variables;

// Variable type can be retrieved for further processing
string type = variables["isDiscount"].Type;

// Retrieving the variable value by key
bool isDiscount = (bool)variables["isDiscount"].Value;

// Variable value can be of different types
string title = (string)variables["title"].Value;

Deprecated methods

These methods are deprecated and will be removed in SDK version 5.0.0.

GetFeatureVariationKey()

• 📨 Sends Tracking Data to Kameleoon

To get feature variation key, call GetFeatureVariationKey().

Use GetVariation() instead.

This method requires a visitorCode and a featureKey (or featureID) to check if a user can access a specific feature.

If the user has never been linked to this feature, the SDK will randomly decide whether to activate it, returning either true (they can access the feature) or false (they cannot). If the user with the given visitorCode is already linked to this feature, the system will return the previous value of the featureFlag.

Make sure to include proper error handling in your code, as shown in the example, to catch any potential errors.

If you specify a visitorCode, the GetFeatureVariationKey() method uses it as the unique visitor identifier, which is useful for cross-device experimentation. When you specify a visitorCode and set the isUniqueIdentifier parameter to true, the SDK links the flushed data with the visitor associated with the specified identifier.

The parameter isUniqueIdentifier is deprecated. Please use UniqueIdentifier instead.

The isUniqueIdentifier can be helpful in unique situations; for example, if you cannot access the anonymous visitorCode given to a visitor, but you can use an internal ID linked to that visitor through session merging.

string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, "example.com");
string featureKey = "new_checkout";
string variationKey = "";

try {
  variationKey = kameleoonClient.GetFeatureVariationKey(visitorCode, featureKey);
} catch (KameleoonException.FeatureNotFound e) {
  // The feature is not yet activated on Kameleoon's side.
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
  // The feature flag is disabled for the environment.
}

switch (variationKey) {
  case "on":
    // Main variation key is selected for visitorCode.
    break;
  case "alternative_variation":
    // Alternative variation key
    break;
  default:
    // Default variation key
    break;
}

Parameters

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
featureKey	string	Key of the feature you want to expose to a user. This field is mandatory.
isUniqueIdentifier (Deprecated)	bool	An optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.

Return value

Type	Description
string	Variation key of the feature flag that is registered for a given visitorCode.

Exceptions thrown

Type	Description
KameleoonException.FeatureNotFound	Exception indicating that the requested feature key has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon’s side (but code implementing the feature is already deployed on the web-application’s side).
KameleoonException.FeatureEnvironmentDisabled	Exception indicating that feature flag is disabled for the visitor’s current environment (for example, production, staging, or development).

GetActiveFeatureListForVisitor()

• Use GetActiveFeatures instead.
• This method was previously called ObtainFeatureListForVisitorCode(), which was removed in SDK version 4.0.0.

This method takes a single visitorCode parameter. Return only the active feature flags for the specified visitor.

var featureListIds = kameleoonClient.GetActiveFeatureListForVisitor(visitorCode)

Parameters

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.

Return value

Type	Description
List<string>	List of active feature flag IDs available for specific visitorCode

GetFeatureVariable()

• 📨 Sends Tracking Data to Kameleoon

Use GetVariation() instead.

To get variable of variation key associated with a user, call the GetFeatureVariable() method of our SDK.

This method requires a visitorCode and a featureKey (or featureID) to check if a user can access a specific feature.

If the user has never been linked to this feature, the SDK will randomly decide whether to activate it, returning either true (they can access the feature) or false (they cannot). If the user with the given visitorCode is already linked to this feature, the system will return the previous value of the featureFlag.

Make sure to include proper error handling in your code, as shown in the example, to catch any potential errors.

If you specify a visitorCode, the GetFeatureVariable() method uses it as the unique visitor identifier, which is useful for cross-device experimentation. When you specify a visitorCode and set the isUniqueIdentifier parameter to true, the SDK links the flushed data with the visitor associated with the specified identifier.

The parameter isUniqueIdentifier is deprecated. Please use UniqueIdentifier instead.

The isUniqueIdentifier can be helpful in unique situations; for example, if you cannot access the anonymous visitorCode given to a visitor, but you can use an internal ID linked to that visitor through session merging.

var visitorCode = kameleoonClient.GetVisitorCode(req, res, "example.com");
const string featureKey = "feature_key";
const string variableKey = "var"

try {
  var variableValue = kameleoonClient.GetFeatureVariable(visitorCode, featureKey, variableKey);
  // Your custom code, depending on variableValue
} catch (KameleoonException.FeatureNotFound e) {
  // The feature is not yet activated in the Kameleoon app
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
  // The feature flag is disabled for the environment
} catch (KameleoonException.FeatureVariableNotFound e) {
  // Requested variable not defined in the Kameleoon app
}

Parameters

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
featureKey	string	Key of the feature you want to expose to a user. This field is mandatory.
variableKey	string	Key of the variable you want to get a value. This field is mandatory.
isUniqueIdentifier (Deprecated)	bool	An optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.

Return value

Type	Description
object	Value of variable of variation that is registered for a given visitorCode for this feature flag. Possible types: bool, int, double, string, JObject, JArray

Exceptions thrown

Type	Description
KameleoonException.FeatureNotFound	Exception indicating that the requested feature key has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon’s side (but code implementing the feature is already deployed on the web application’s side).
KameleoonException.FeatureEnvironmentDisabled	Exception indicating that feature flag is disabled for the visitor’s current environment (for example, production, staging, or development).
KameleoonException.FeatureVariableNotFound	Exception indicating that the requested variable wasn’t found. Check that the variable’s key in the Kameleoon app matches the one in your code.
KameleoonException.VisitorCodeInvalid	Exception indicating that the specified visitor code is not valid. (It is either empty or longer than 255 characters).

GetActiveFeatures()

Use GetVariations() instead.

GetActiveFeatures method retrieves information about the active feature flags that are available for the specified visitor code.

The Kameleoon.Types.Variation.Id and Kameleoon.Types.Variation.ExperimentId properties of returned variations are optional. If not specified, the default value is Kameleoon.Types.Variation.UndefinedId.

IReadOnlyDictionary<string, Kameleoon.Types.Variation> activeFeatures = GetActiveFeatures(visitorCode);

Parameters

Name	Type	Description
visitorCode	string	Unique identifier of the visitor you want to retrieve active feature flags for. This field is mandatory.

Return value

Type	Description
IReadOnlyDictionary<string, Kameleoon.Types.Variation>	A dictionary that contains the assigned variations of the active features using the active feature IDs as keys.

Exceptions thrown

Type	Description
KameleoonException.VisitorCodeInvalid	Exception indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.

GetFeatureVariationVariables()

• Use GetVariation() instead.
• This method was previously called GetFeatureAllVariables(), which was removed in SDK version 4.0.0.

Call this method to retrieve all feature variables for a feature. You can modify feature variables in the Kameleoon app.

This method takes two input parameters: featureKey and variationKey. It returns the data with the Dictionary<string, object> type, as defined on the web interface. It will throw an exception (KameleoonException.FeatureNotFound) if the requested feature has not been found in the SDK’s internal configuration.

string featureKey = "myFeature";

try {
  var allVariables = kameleoonClient.GetFeatureVariationVariables(featureKey, variationKey);
} catch (KameleoonException.FeatureNotFound e) {
  // The feature is not yet activated in the Kameleoon app.
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
  // The feature flag is disabled for the environment.
} catch (KameleoonException.FeatureVariationNotFound e) {
  // The variation is not activated in the Kameleoon app (the associated experiment is not online).
} catch (Exception e) {
  // This is a generic Exception handler which will handle all exceptions.
  Console.WriteLine("Exception occurred");
}

Parameters

Name	Type	Description
featureKey	string	Identifier key of the feature you need to obtain. This field is mandatory.
variationKey	string	Key of the variation you want to obtain. This field is required.

Return value

Type	Description
Dictionary<string, object>	Data associated with this feature flag. The values of can be a number, string, boolean or object (depending on the type defined on the web interface).

Exceptions thrown

Type	Description
KameleoonException.FeatureNotFound	Exception indicating that the requested feature has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon’s side.
KameleoonException.FeatureEnvironmentDisabled	Exception indicating that the feature flag is disabled for the visitor’s current environment (for example, production, staging, or development).
KameleoonException.FeatureVariationNotFound	Exception indicating that the requested variation ID wasn’t found in the internal configuration of the SDK. This usually means that the variation’s corresponding experiment is not activated in the Kameleoon app.