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

Opt out

Opt a visitor out of Optimizely Web Experimentation tracking by disabling Optimizely.

Syntax

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

Parameters

Parameter and TypeChild AttributeDescription
optOut
OptOutObject
N/AAn object with the type field set to optOut. The other fields are the function arguments. Required.
type
string
Child attribute of type OptOutObjectThe argument indicating that you are using the optOut function. Required.
isOptOut
Boolean
Child attribute of type OptOutObjectIt's possible to opt in a previously opted-out visitor.

Example Call

window["optimizely"].push({
  "type": "optOut",
  "isOptOut": true
});

Description

Opt a visitor out of Optimizely Web Experimentation tracking by disabling Optimizely Web Experimentation. For example, you may want to opt visitors out of Optimizely Web Experimentation tracking as part of your site's broader opt-out preferences.