The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.
Jump to Content
Dev Guide
API Reference
User Guide
Dev Guide
API Reference
Commerce Connect
Configured Commerce
Content Management System
Content Marketing Platform
Cross-platform products
Digital Experience Platform
Experimentation Data
Feature Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Recommendations
Web Experimentation
Campaign
Deprecated Products
Dev Guide
API Reference
User Guide
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
API Reference
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
Web Experimentation
API Reference
Hold events
All
Pages
Start typing to search…
JUMP TO
Optimizely Web Experimentation
JavaScript API
Push
Activate
Cookie expiration
Add listener
Bucket visitor
Cookie domain
Event
Disable cross origin
Disable
Hold events
Extend cookie lifetime
Log
Opt out
Page
Send events
Wait for origin sync
User
Tags
Get
Behavior
DCP
jQuery
Data
State
Utils
Visitor
Visitor ID
Optimizely API
Get started with Experimentation REST API
Projects
List Projects
get
Create a Project
post
Read a Project
get
Update a Project
patch
Campaigns
List Campaigns
get
Create a Campaign
post
Archive a Campaign
del
Read a Campaign
get
Update a Campaign
patch
Get Campaign results
get
Get a sharable link for the campaign's results page
get
Get Campaign results as a CSV
get
Experiments
List Experiments
get
Create an Experiment
post
Archive an Experiment
del
Read an Experiment
get
Update an Experiment
patch
Get Experiment results
get
Get a sharable link for the experiment's results page
get
Get Experiment results time series
get
Get Experiment results as a CSV
get
Audiences
List Audiences
get
Create an Audience
post
Read an Audience
get
Update an Audience
patch
Pages
List Pages
get
Create a Page
post
Archived a Page
del
Read a page
get
Update a Page
patch
Events
List all Events
get
Get Event by ID
get
Create an In-Page Event
post
Archive an In-Page Event
del
Update an In-Page Event
patch
Create a Custom Event
post
Archive a Custom Event
del
Update a Custom Event
patch
Attributes
List Attributes
get
Create an Attribute
post
Archive an Attribute
del
Read an Attribute
get
Update an Attribute
patch
Groups
List Exclusion Groups
get
Create an Exclusion Group
post
Archive an Exclusion Group
del
Get an Exclusion Group
get
Update an Exclusion Group
patch
Extensions
List Extensions
get
Create an Extension
post
Archive an Extension
del
Get an Extension
get
Update an Extension
patch
Plan
Get Plan & Usage information for all products
get
Scheduled Jobs
Get a list of Scheduled Jobs
get
Create a Scheduled Job
post
Archive a Scheduled Job
del
Get a Scheduled Job
get
Update a Scheduled Job
patch
User
Get current User information
get
List Attributes
Get list attributes by project
get
Create a List Attribute
post
Archive a List Attribute
del
Read a List Attribute
get
Update a List Attribute
patch
Sections
Read all the Sections in a Multivariate Test
get
Create a new Section in a Multivariate Test
post
Archive a Section by ID
del
Read a Section of a Multivariate Test
get
Update a Section by ID
patch
Features
Get Features by Project
get
Create a Feature
post
Archive a Feature
del
Read a Feature
get
Update a Feature
patch
Subject Access Requests
List Subject Access Requests by data source and status
get
Update a Subject Access Request
patch
Update a Subject Access Request
post
List Subject Access Requests
get
Create a Subject Access Request
post
Get Subject Access Request
get
Environments
Get Environments by Project
get
Create an Environment
post
Archive an Environment
del
Read an Environment
get
Update an Environment
patch
Read the datafile of an Environment
get
Search
Search
get
Change History
Retrieve changes for a project.
get
Attribution
Get bucketing information for a visitor
get
Export Credentials
Get aws credentials to access enriched events dataset
get
Impressions Usage
Get Impressions Usage
get
Collaborators
List Collaborators
get
Invite Collaborators
post
List Collaborators who have not yet accepted the invitations
get
ExperimentSummary
Summaries of Experiments and Campaigns
get
Reports
Get Experiment Result's Report
get
Webhooks
Get Webhooks by Project
get
Create a Webhook
post
Delete a Webhook
del
Read a Webhook
get
Update a Webhook
patch
Recommendations
Download a CSV with all current catalog data
get
Download a CSV with all computed recommendations output data
get
Download a CSV with summary stats data
get
Powered by
Hold events
Ask AI
Instruct the Optimizely Web Experimentation snippet to hold and enqueue events.
