State

Get the Optimizely state

Syntax

const state = window["optimizely"].get("state");

Parameters

Return value

Example

const state = window["optimizely"].get("state");

getCampaignStates()

Get all the campaigns and their current states.

Syntax

state.getCampaignStates(filter);

Parameters

CampaignFilterObject fields

Return value

Example call

state.getCampaignStates({ isActive: true });

Example return value

{
  "6676370413": {
    "id": "6676370413",
    "campaignName": "Example personalization campaign",
    "experiment": { "id": "6666781105", "name": null },
    "variation": { "id": "6626731852", "name": "Variation #1" },
    "isActive": true,
    "visitorRedirected": false,
    "isInCampaignHoldback": false,
    "audiences": [{ "id": "6672770135", "name": "Chrome users" }]
  }
}

Description

Get all the campaigns and their current states. Use a filter object or function to limit the results.

Example: filter with a function

const state = window["optimizely"].get("state");

state.getCampaignStates(function (campaignState) {
  return !!campaignState.isActive;
});

getExperimentStates()

Get all the experiments and their current states.

Syntax

state.getExperimentStates(filter);

Parameters

CampaignFilterObject fields

Return value

Example call

state.getExperimentStates({ isActive: true });

Example return value

{
  "6666781105": {
    "id": "6666781105",
    "experimentName": null,
    "variation": { "id": "6626731852", "name": "Variation #1" },
    "isActive": true,
    "visitorRedirected": false,
    "isInExperimentHoldback": false,
    "audiences": [{ "id": "6672770135", "name": "Chrome users" }]
  }
}

Description

Get A/B experiments and their current states (excludes Personalization campaigns). Use a filter object or function to limit results.

Examples

Filter with a function

const state = window["optimizely"].get("state");

// "Not variation #1"
state.getExperimentStates(function (expState) {
  return !expState.variation || expState.variation.name !== "Variation #1";
});

Filter with an object

const state = window["optimizely"].get("state");

state.getExperimentStates({ isActive: true });

getPageStates()

Get all the pages and their current states.

Syntax

state.getPageStates(filter);

Parameters

Return value

Example call

state.getPageStates({ isActive: true });

Example return value

{
  "6678290257": {
    "id": "6678290257",
    "name": "Homepage",
    "apiName": "homepage",
    "category": "other",
    "staticConditions": ["and", ["or", { "type": "url", "value": "https://developers.optimizely.com/", "match": "simple" }]],
    "tags": [{
      "category": "other",
      "locator": ".push-quad > a:nth-of-type(1)",
      "valueType": "string",
      "locatorType": "css_selector",
      "apiName": "view_docs_button"
    }],
    "isActive": true,
    "metadata": { "view_docs_button": "View Docs" }
  }
}

Description

Get all the pages and their current states. Use a filter object to limit results.

Example: filter with a function

const state = window["optimizely"].get("state");

state.getCampaignStates(function (pageState) {
  return !!pageState.isActive;
});

📘

Note

The previous example demonstrates function-style filtering. Swap in getPageStates if you prefer to filter page states specifically.

getVariationMap()

Get a mapping from each experiment the visitor has ever seen to its current corresponding variation.

Syntax

state.getVariationMap();

Return value

Example call

state.getVariationMap();

Example return value

{
  "6661191859": {
    "id": "6670551924",
    "name": "Variation #1",
    "index": 1
  }
}

Description

Get the mapping of all experiments the visitor has ever seen to its current corresponding variation. If the visitor is excluded from an experiment due to traffic allocation, the experiment is considered active and the visitor is bucketed into a variation, but no visual changes are applied.

getActiveExperimentIds()

Get an array of experiment IDs that are currently active on the page for the visitor.

Syntax

state.getActiveExperimentIds();

Return value

Example call

state.getActiveExperimentIds();

Example return value

["6661191859", "6666781105", "7555673865"]

Description

Get an array of experiment IDs that are currently active on the page for the visitor. If the visitor is excluded from an experiment due to traffic allocation, the experiment is considered active and the visitor is bucketed into a variation, but no visual changes are applied. This situation is referred to as isInExperimentHoldback in the getExperimentStates API:

state.getExperimentStates()[{experiment_id}].isInExperimentHoldback

getRedirectInfo()

If a redirect variation was executed on the previous page, all the experiment details are accessible on the next page through getRedirectInfo().

Syntax

state.getRedirectInfo();

Return value

Example call

state.getRedirectInfo();

Example return value

{
  "experimentId": "7669390999",
  "variationId": "7662661235",
  "referrer": "https://www.google.com/"
}

Description

Use this when you need to correct referrer values in analytics after a redirect variation.

getDecisionString()

Get a single string describing the campaign/experiment decision for a given campaign ID.

Syntax

state.getDecisionString(config);

Parameters

Return value

Example call

state.getDecisionString({ "campaignId": "6676370413" });

Example return value

"Example personalization campaign(6676370413):Example experiment(6666781105):Variation #1(6626731852):holdback"

Description

Often used to send campaign decision data to third-party analytics. Pass a campaign ID. If the campaign is an A/B test, the API returns only the fields relevant to A/B tests. Your code does not need to branch on campaign type.

getDecisionObject()

Get an object with strings that describe the campaign or experiment decision for a given campaign ID.

Syntax

state.getDecisionObject(config);

Parameters

Return value

Example call

state.getDecisionObject({ "campaignId": "6676370413" });

Example return value

{
  "campaign": "Shopping Cart (6676370413)",
  "experiment": "New Visitors (3243212353)",
  "variation": "Variation #1 (2344343121)",
  "holdback": false
}

Description

Often used to send campaign decision data to third-party analytics. Pass a campaign ID. If the campaign is an A/B test, the API returns only A/B-relevant fields so your code does not need to branch on type.