The VWO client class needs to be instantiated as an instance that exposes various API methods like activate, getVariationName and track.

Each VWO client represents the state of a project corresponding to the settingsFile. SettingsFile needs to be fetched before instantiating a VWO client. Read more on how to get SettingsFile.

API Description

SDK provides a method to instantiate a VWO client as an instance. The method accepts an object to configure the VWO client.

The only required parameter for instantiating the SDK is settings file. There are other optional parameters, which you could provide for overriding the default behavior or setting environment.

Parameter Definitions

Below is the list of all parameters that can be used for configuring the VWO SDK.

Parameter

Type

Description

settingsFile
Required

Object

The JSON representing your project and the campaign settings.

isDevelopmentMode
Optional

Boolean

Flag for experimenting the SDK on test-app/staging so that no impression is sent to the VWO server for tracking.

userStorageService
Optional

Object

The JSON representing the User Campaign Data Map. Used for sticky bucketing and deciding when to call Activate API vs. getVariationName API.

logging
Optional

Object

Override default logger behaviour. Customise log-level, and implement your own log message.

goalTypeToTrack
Optional

String

If you want to track a particular goal across multiple campaigns(having the same identifier), use this flag to define which type of goal you would like to track i.e. conversion-only or revenue-only, or both. Defaults to ALL i.e. Conversion as well as Revenue goals.

Returns

An instance of the VWO class, which can be referenced later for calling out different API methods.

Usage

var vwoSDK = require('vwo-node-sdk');

vwoSDK.getSettingsFile(accountId, sdkKey).then(function (settingsFile) {
  // ...launch SDK and call APIs
  var vwoClientInstance = vwoSDK.launch({
    settingsFile: settingsFile
    });
});

Did this page help you?