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 GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Opt out

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

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

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 OptOutObject.The argument indicating that you are using the optOut function. Required.
isOptOut
Boolean
Child attribute of type OptOutObject.You cannot opt in a previously opted-out visitor because opting a visitor out blocks the entire Optimizely snippet from loading.

Example call

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