Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Activate

Reactivate the snippet.

Syntax

window["optimizely"].push(activate);

Parameters

Parameter and TypeChild AttributeDescription
activate
ActivateObject
N/AAn object with the typefield set to activate.The other fields are the function arguments. Required.
type
string
Child attribute of type ActivateObjectThe argument indicating that you are using the activate function. Required.

Example Call

// ensures the optimizely object is defined globally
window['optimizely'] = window['optimizely'] || [];

// sends the activate push to the Optimizely snippet
window["optimizely"].push({
  "type": "activate"
});

Description

Trigger a snippet activation

The snippet "activation" phase is where:

  • The visitor's IDs are read from cookies, and if updated, data for that visitor is read from storage.
  • Immediately activated pages are activated.
  • All other pages are queued for activation.
  • Information about the environment, such as previous behavior and data from third parties, are fetched.
  • A snippet activation event is tracked and a new "activationId" created to distinguish from the prior activation.

In this way, calling the "activate" API is analogous to loading Optimizely Web Experimentation in a new page view but without requiring the page to be reloaded. This is especially useful in a single-page app context to enable the views of a single-page app to emulate the behavior of Optimizely Web Experimentation in multipage websites.