Skip to main content

C# SDK

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.

Latest version of the C# SDK: 4.4.0 (changelog).

Getting started

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

Install the C# client

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

Install-Package KameleoonClient -Version 4.4.0

Additional configuration

Create a .properties configuration file to provide credentials and customize the SDK behavior. You can also download a sample configuration file. Save this file in the default path /etc/kameleoon/client-csharp.conf. If you place it 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.

The following table shows the available properties that you can set:

KeyDescription
client_idRequired for authentication to the Kameleoon service. To find your client_id, see the API credentials documentation.
client_secretRequired for authentication to the Kameleoon service. To find your client_secret, see the API credentials documentation.
session_duration_minuteDesignates the time interval (in minutes) 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. The default session duration is 30 minutes.
refresh_interval_minuteSpecifies 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. If left unspecified, the default interval is set to 60 minutes. 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.
default_timeout_millisecondSpecifies 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. The default value is 10 seconds. Some methods have their additional parameters for method-specific timeouts, but if you do not specify them explicitly, the default value is used.
environmentEnvironment from which a feature flag’s configuration is to be used. The value can be production, staging, development. The default environment value is production. See the managing environments article for details.
top_level_domainThe 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. This field is mandatory.
proxy_hostSets the proxy host for all outgoing server calls made by the SDK.

Initialize the Kameleoon client

After you've installed the SDK into your application 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)
environment: "development", // optional
topLevelDomain: "example.com", // mandatory if you use hybrid mode (engine or web experiments)
proxyHost: "proxy.host.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
}

A IKameleoonClient is a singleton object that acts as a bridge between your application and the Kameleoon platform. It includes all the methods and properties you need to run an experiment.

It's your responsibility as the app developer to ensure your application code uses the correct logic within the context of A/B testing via Kameleoon. It's a best practice to assume that you can exclude the current visitor from the experiment if the experiment has not yet been launched. This is easy to do, because this practice corresponds to the default and reference variation logic.

Reference

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

Kameleoon.KameleoonClientFactory

Create()

The starting point for using the SDK is the initialization step. All of your app's interaction with the SDK is done through an instance of the KameleoonClient class. Create this object using the KameleoonClientFactory Create() static method.

Arguments
NameTypeDescription
siteCodestringCode of the website you want to run experiments on. This unique code id can be found in our platform's back-office. This field is mandatory.
configurationFilePathstringPath to the SDK configuration file. This field is optional and set to /etc/kameleoon/client-csharp.conf by default.
kameleoonConfigKameleoonClientConfigConfiguration SDK object that you can pass instead of using a configuration file. This field is optional.
Return value
TypeDescription
IKameleoonClientAn instance of the KameleoonClient class, that will be used to manage your experiments and feature flags.
Exceptions thrown
TypeDescription
KameleoonException.ConfigCredentialsInvalidException indicating that the requested credentials were not provided in the configuration file or as arguments on the method.
KameleoonException.SiteCodeIsEmptyException indicating that the specified site code is empty string which is invalid value.
Example code
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)
environment: "development", // optional
topLevelDomain: "example.com", // mandatory if you use hybrid mode (engine or web experiments)
proxyHost: "proxy.host.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
}

Kameleoon.IKameleoonClient

WaitInit()

WaitInit() awaits the initialization of the Kameleoon client. This method allows you to check if the client has been successfully initialized before proceeding with other operations.

Return value
TypeDescription
TaskThe task will complete when the client has been successfully initialized.
Exceptions thrown
TypeDescription
ExceptionException indicating that client is not initialized properly and cannot be used yet.
Example code
using static Kameleoon;

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

GetVisitorCode()

note

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

The GetVisitorCode() helper method should be called to obtain the Kameleoon visitorCode for the current visitor. This is especially important when using Kameleoon in a mixed front-end and back-end environment, where user identification consistency must be guaranteed. The implementation logic is described here:

  1. First, check if a kameleoonVisitorCode cookie or query parameter associated with the current HTTP request exists. If so, use this as the visitor identifier and skip the next step.

  2. If no cookie or parameter is found in the current request, either randomly generate a new identifier, or use the defaultVisitorCode argument as identifier if it is passed. This allows you to use your own identifiers as visitor codes, if desired. This can help you match Kameleoon visitors with your own users without any additional look-ups in a matching table.

  3. Set the server-side kameleoonVisitorCode cookie (via HTTP header) with the identifier value. This identifier value is then returned by the method.

note

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.

Arguments
NameTypeDescription
RequestMicrosoft.AspNetCore.Http.HttpRequest / System.Web.HttpRequestThe current Request object should be passed as the first parameter. This field is mandatory.
ResponseMicrosoft.AspNetCore.Http.HttpResponse / System.Web.HttpResponseThe current Response object should be passed as the second parameter. This field is mandatory.
defaultVisitorCodestringThis 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
TypeDescription
stringA visitorCode that will be associated with this particular user and should be used with most of the methods of the SDK.
Example code
using static Kameleoon;

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

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

string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, Guid.NewGuid().ToString());

IsFeatureActive

note

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

To activate a feature toggle, call the IsFeatureActive method of our SDK.

This method takes a visitorCode and featureKey (or featureID) as mandatory arguments to check if the specified feature will be active for a given user.

If such a user has never been associated with this feature flag, the SDK returns a boolean value randomly (true if the user should have this feature or false if not). If a user with a given visitorCode is already registered with this feature flag, it will detect the previous featureFlag value.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

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.

note

The isUniqueIdentifier can also be useful in other 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.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
featureKeystringKey of the feature you want to expose to a user. This field is mandatory.
Return value
TypeDescription
boolValue of the feature that is registered for a given visitorCode.
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException 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).
string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, "example.com");
string featureKey = "new_checkout";
bool hasNewCheckout = false;

try {
hasNewCheckout = kameleoonClient.IsFeatureActive(visitorCode, featureKey, isUniqueIdentifier: false);
}
catch (KameleoonException.NotTargeted e) {
/*
The user did not trigger the feature, as the associated targeting segment
conditions were not fulfilled. The feature should be considered inactive.
*/
hasNewCheckout = 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 generic Exception handler which will handle all exceptions.
Console.WriteLine("Exception occured");
}
if (hasNewCheckout)
{
// Implement new checkout code here
}

GetFeatureVariationKey

To get feature variation key, call GetFeatureVariationKey().

This method takes a visitorCode and featureKey as mandatory arguments to get variation key for a given user.

If such a user has never been associated with this feature flag, the SDK returns a variation key randomly (according to the feature flag rules). If a user with a given visitorCode is already registered with this feature flag, it will detect the previous variation key value. If the user does not match any of the rules, the default value will be returned, which we can define in your customer's account.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

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.

note

The isUniqueIdentifier can also be useful in other 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.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
featureKeystringKey of the feature you want to expose to a user. This field is mandatory.
isUniqueIdentifierboolAn 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
TypeDescription
stringVariation key of the feature flag that is registered for a given visitorCode.
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException 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.FeatureEnvironmentDisabledException indicating that feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
string visitorCode = kameleoonClient.GetVisitorCode(Request, Response, "example.com");
string featureKey = "new_checkout";
string variationKey = "";

try {
variationKey = kameleoonClient.GetFeatureVariationKey(visitorCode, featureKey, isUniqueIdentifier: false);
} 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;
}

GetFeatureVariable()

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

This method takes a visitorCode, featureKey and variableKey as mandatory arguments to get a variable of variation key for a given user.

If such a user has never been associated with this feature flag, the SDK returns a variable value of variation key randomly (according to the feature flag rules). If a user with a given visitorCode is already registered with this feature flag, it will detect the variable value for previous associated variation. If the user does not match any of the rules, the variable of default value will be returned.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

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.

note

The isUniqueIdentifier can also be useful in other 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.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
featureKeystringKey of the feature you want to expose to a user. This field is mandatory.
variableKeystringKey of the variable you want to get a value. This field is mandatory.
isUniqueIdentifierboolAn 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
TypeDescription
objectValue 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
TypeDescription
KameleoonException.FeatureNotFoundException 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.FeatureEnvironmentDisabledException indicating that feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
Example code
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, isUniqueIdentifier: false);
// Your custom code depending of 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
}

GetFeatureVariationVariables()

note

This method was previously named 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 will return 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 internal configuration of the SDK.

Arguments
NameTypeDescription
featureKeystringIdentificator key of the feature you need to obtain. This field is mandatory.
variationKeystringKey of the variation you want to obtain. This field is required.
Return value
TypeDescription
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
TypeDescription
KameleoonException.FeatureNotFoundException 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.FeatureEnvironmentDisabledException indicating that the feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
KameleoonException.FeatureVariationNotFoundException 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.
Example code
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 generic Exception handler which will handle all exceptions.
Console.WriteLine("Exception occurred");
}

TrackConversion()

To track conversion, use the TrackConversion() method. This method requires visitorCode and goalId to track conversion on this particular goal. In addition, this method also accepts revenue as a third optional argument to track revenue. The visitorCode usually is 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.

If you specify a visitorCode, the TrackConversion() 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.

note

The isUniqueIdentifier can also be useful in other 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.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
goalIdintID of the goal. This field is mandatory.
revenuefloatRevenue of the conversion. This field is optional.
isUniqueIdentifierboolAn optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.
Example code
using Kameleoon;
using Kameleoon.Data;

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

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

kameleoonClient.TrackConversion(visitorCode, goalID);

kameleoonClient.TrackConversion(visitorCode, goalID, isUniqueIdentifier: true); // if you operate with unique ID

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 the Flush(). Note that TrackConversion() also sends out any previously associated data, just like the Flush() method. The same is true for GetFeatureVariationKey and GetFeatureVariable methods if an experimentation rule is triggered.

tip

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 customDataIndex.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
dataTypesIDataCustom data types which may be passed separated by a comma.
Example code
kameleoonClient.AddData(new Browser(Browser.Browsers.CHROME));
kameleoonClient.AddData(
visitorCode,
new PageView("https://url.com", "title", new int[] {3}),
new Interest(0)
);
kameleoonClient.AddData(visitorCode, new Conversion(32, 10f, false));

Flush

Data associated with the current user via AddData() method is not sent immediately to the server. It is stored and accumulated until the apps calls TrackConversion() or Flush(). This allows you to control exactly when the data is flushed to our servers. For instance, calling AddData() a dozen times would be a waste of resources as this would send data to the server after each AddData() invocation. Just 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 Flush() method doesn't return any value. This method is non-blocking as the server call is made asynchronously.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
isUniqueIdentifierboolAn optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.
Example code
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 Interest(0)
);
kameleoonClient.AddData(visitorCode, new Conversion(32, 10f, false));

kameleoonClient.Flush(visitorCode);

kameleoonClient.Flush(visitorCode, isUniqueIdentifier: true); // if you operate with unique ID

GetFeatureList()

note

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

Returns a list of feature flag IDs currently available for the SDK

Return value
TypeDescription
List<int>List of feature flag IDs
Example code
const featureFlagIds = kameleoonClient.GetFeatureList()

GetActiveFeatureListForVisitor()

note

This method is deprecated and will be removed in SDK version 5.0.0. Use GetActiveFeatures instead.

note

This method was previously named 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.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is mandatory.
Return value
TypeDescription
List<string>List of active feature flag IDs available for specific visitorCode
Example code
var featureListIds = kameleoonClient.GetActiveFeatureListForVisitor(visitorCode)

GetActiveFeatures()

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

note

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.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the visitor you want to retrieve active feature flags for. This field is mandatory.
Return value
TypeDescription
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
TypeDescription
KameleoonException.VisitorCodeInvalidException indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.
Example code
IReadOnlyDictionary<string, Kameleoon.Types.Variation> activeFeatures = GetActiveFeatures(visitorCode);

GetRemoteData()

note

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

GetRemoteData() allows you to retrieve data (according to a key passed as argument) for specified siteCode (specified in KameleoonClientFactory.create()) stored on a remote Kameleoon server. Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors.

Note that since a server call is required, this mechanism is asynchronous.

Arguments
NameTypeDescription
keystringThe key that the data you try to get is associated with. This field is mandatory.
timeoutint?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
TypeDescription
JObjectData associated with retrieving data for specific key.
Exceptions thrown
TypeDescription
ExceptionException indicating that the request timed out or retrieved data can't be parsed with JObject.Parse method.
Example code
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
}

GetRemoteVisitorData()

GetRemoteVisitorData() allows you to retrieve data assigned to a visitor (according to a visitorCode passed as argument) for specified siteCode (specified in KameleoonClientFactory.Create()) stored on a remote Kameleoon server. Method automatically adds retrieved data for a visitor (accroding to a addData parameter). Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors.

If you specify a visitorCode, the GetRemoteVisitorData() 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.

note

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.

Arguments
NameTypeDescription
visitorCodestringThe visitor code for which you want to retrieve the assigned data. This field is mandatory.
addDataboolA boolean indicating whether the method should automatically add retrieved data for a visitor. This field is optional.
timeoutint?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.
filterKameleoon.Types.RemoteVisitorDataFilterFilter 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 filed is optional.
isUniqueIdentifierboolAn optional parameter for specifying if the visitorCode is a unique identifier. If not provided, the default value is false. The field is optional.
note

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

NameTypeDescriptionDefault
previousVisitAmount (optional)intNumber of previous visits to retrieve data from. Number between 1 and 251
currentVisit (optional)booleanIf true, current visit data will be retrievedtrue
customData (optional)booleanIf true, custom data will be retrieved.true
pageViews (optional)booleanIf true, page data will be retrieved.false
geolocation (optional)booleanIf true, geolocation data will be retrieved.false
device (optional)booleanIf true, device data will be retrieved.false
browser (optional)booleanIf true, browser data will be retrieved.false
operatingSystem (optional)booleanIf true, operating system data will be retrieved.false
conversions (optional)booleanIf true, conversion data will be retrieved.false
experiments (optional)booleanIf true, experiment data will be retrieved.false
Return value
TypeDescription
Task<IReadOnlyCollection<IData>>Collection associated with a given visitor.
Exceptions thrown
TypeDescription
HttpRequestExceptionException indicating that the request was failed for any reason.
ExceptionException indicating that the request timed out or any other reason of failure.
Example code
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);

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

GetVisitorWarehouseAudience()

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.

Arguments
NameTypeDescription
visitorCodestringA unique visitor identification string, can't exceed 255 characters length.
customDataIndexintAn integer representing the index of the custom data you want to use to target your BigQuery Audiences.
warehouseKeystringA unique key to identify the warehouse data (usually, your internal user ID). This field is optional.
timeoutint?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
TypeDescription
Task<CustomData>A CustomData instance confirming that the data has been added to the visitor.
Exceptions thrown
TypeDescription
KameleoonException.VisitorCodeInvalidException indicating that the provided visitor code is not valid (it is either empty or longer than 255 characters).
HttpRequestExceptionException indicating that the request was failed for any reason.
ExceptionException indicating that the request timed out or any other reason of failure.
Example code
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
}

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.

Arguments
NameTypeDescription
handlerActionThe handler that will be called when the configuration is updated using a real-time configuration event.
Example code
kameleoonClient.UpdateConfigurationHandler(async delegate () {
// Configuration was updated
});

GetEngineTrackingCode()

Kameleoon offers built-in integrations with various analytics solutions, such as Mixpanel, Google Analytics 4, and Segment. To ensure that you can track and analyze your server-side experiments, Kameleoon provides the GetEngineTrackingCode() method that allows you to automatically send exposure events to your analytics solution. The SDK builds a tracking code for your active analytics solution based on the experiments that the visitor has triggered in the last 5 seconds. For more information on how to implement this method, see the Hybrid experimentation documentation.

note

To benefit from this feature, you will need to implement both the C# SDK and our Kameleoon JavaScript tag. We recommend you implement the Kameleoon Asynchronous tag, which you can install before your closing <body> tag in your HTML page, as it will be only used for tracking purposes.

Method getEngineTrackingCode() returns Kameleoon tracking code for the current visitor. Tracking code is built based the experiments that were triggered during the last 5 seconds.

Arguments
NameTypeDescription
visitorCodestringThe user's unique identifier. This field is mandatory.
Return value
TypeDescription
stringJavaScript code to be inserted in your page
Example code
string engineTrackingCode = kameleoonClient.GetEngineTrackingCode(visitorCode);
// The following string will be returned:
//
// window.kameleoonQueue = window.kameleoonQueue || [];
// window.kameleoonQueue.push(['Experiments.assignVariation', experiment1ID, variation1ID]);
// window.kameleoonQueue.push(['Experiments.trigger', experiment1ID, true]);
// window.kameleoonQueue.push(['Experiments.assignVariation', experiment2ID, variation2ID]);
// window.kameleoonQueue.push(['Experiments.trigger', experiment2ID, true]);
//
// Here, experiment1ID, experiment2ID and variation1ID, variation2ID represent
// the specific experiments and variations that users have been assigned to.

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 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.

Arguments
NameTypeDescription
visitorCodestringThe user's unique identifier. This field is required.
legalConsentboolA 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.
responseMicrosoft.AspNetCore.Http.HttpResponse / System.Web.HttpRequestThe HTTP response where values in the cookies will be adjusted based on the legal consent status. This field is optional.
Exceptions thrown
TypeDescription
KameleoonException.VisitorCodeInvalidException indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.
Example code
string visitorCode = kameleoonClient.GetVisitorCode(httpRequest, httpResponse);
kameleoonClient.SetLegalConsent(visitorCode, true, httpResponse);

Kameleoon.Data.IData

Data available in the SDK is not available for targeting and reporting in the Kameleoon app until you add the data. For example, by using the addData() method. See Use visit history to target users for more information.

note

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

Browser

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

kameleoonClient.AddData(visitorCode, new Browser(Browser.Browsers.SAFARI, 16));
NameTypeDescription
browserBrowser.BrowsersList of browsers: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER. This field is mandatory.
versionfloatVersion of browser. This field is optional.

PageView

NameTypeDescription
urlstringURL of the page viewed. This field is mandatory.
titlestringTitle of the page viewed. This field is mandatory.
referrersint[]Referrers of viewed pages. This field is optional.
note

The index (ID) of the referrer is available on 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.
https://help.kameleoon.com/create-acquisition-channel

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

Conversion

NameTypeDescription
goalIDintID of the goal. This field is mandatory.
revenuefloatConversion revenue. This field is optional.
negativeboolDefines if the revenue is positive or negative. This field is optional.
kameleoonClient.AddData(visitorCode, new Conversion(32, 10f, false));

CustomData

NameTypeDescription
indexintIndex / ID of the custom data to be stored. This field is mandatory.
valuestringValue of the custom data to be stored. This field is mandatory.
note

The index (ID) of the custom data is available in the Kameleoon app, in the Custom data configuration page. Be careful: this index starts at 0, so the first custom data you create for a given site would have the ID 0, not 1.

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

Device

NameTypeDescription
deviceDevice.TypeList of devices: PHONE, TABLET, DESKTOP. This field is mandatory.
kameleoonClient.AddData(visitorCode, new Device(Device.Type.DESKTOP));

UserAgent

NameTypeDescription
ValuestringThe UserAgent value that will be sent with tracking requests. This field is mandatory.
kameleoonClient.AddData(visitorCode, new UserAgent("Your User Agent"));

Server-side experiments are more vulnerable to bot traffic than client-side experiments. To address this, Kameleoon uses the IAB/ABC International Spiders and Bots List to identify known bots and spiders. Kameleoon also uses the UserAgent field to filter out bots and other unwanted traffic that could otherwise skew your conversion metrics. For more details, see the 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.

OperatingSystem

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

note

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

NameTypeDescription
typeOperatingSystem.TypeList of operating systems: WINDOWS, MAC, IOS, LINUX, ANDROID and WINDOWS_PHONE. This field is required.
kameleoonClient.addData(visitorCode, new OperatingSystem(OperatingSystem.Type.WINDOWS));

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

note

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

NameTypeDescription
cookiesIReadOnlyDictionary<string, string>A string object map consisting of cookie keys and values. This field is required.
Cookie cookie = new Cookie (new Dictionary<string, string>() {
{ "k1", "v1" },
{ "k2", "v2" },
});
kameleoonClient.addData(visitorCode, cookie);

Geolocation

Geolocation contains the visitor's geolocation details.

note

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

NameTypeDescription
countrystringThe country of the visitor. The field is required.
regionstringThe region of the visitor. The field is optional.
citystringThe city of the visitor. The field is optional.
postalCodestringThe postal code of the visitor. The field is optional.
latitudefloatThe latitude of position of the visitor. Coordinate number represents decimal degrees (double that can be negative). The field is optional.
longitudefloatThe longitude of position of the visitor. Coordinate number represents decimal degrees (double that can be negative). The field is optional.
kameleoonClient.addData(visitorCode, new Geolocation("France", "Île-de-France", "Paris"));

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 supported by this SDK, see Use visit history to target users.

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