API functions
Push
Get

Get started with Experimentation REST API
Projects
Campaigns
Experiments
Audiences
Pages
Events
Attributes
Groups
Extensions
Plan
- Get Plan & Usage information for all productsget
Scheduled Jobs
User
- Get current User informationget
List Attributes
Sections
Features
Subject Access Requests
Environments
Search
- Searchget
Change History
- Retrieve changes for a project.get
Attribution
- Get bucketing information for a visitorget
Export Credentials
- Get aws credentials to access enriched events datasetget
Impressions Usage
- Get Impressions Usageget
- Get Impressions Usage Summaryget
Collaborators
ExperimentSummary
- Summaries of Experiments and Campaignsget
Reports
- Get Experiment Result's Reportget
Webhooks
Recommendations

MetricSets
Metrics

Get Event by ID

get https://api.optimizely.com/v2/events/{event_id}

Get Event by ID

URL Expired

The URL for this request expired after 30 days.

Path Params

event_id

int64

required

The Event ID of the Event you want to get

Query Params

include_classic

boolean

Whether or not to return a classic Event if the specified event_id belongs to a classic Event. If this parameter is not provided it will default to false

Responses

Response body

object

archived

boolean

Whether or not this Event is archived

category

string

add_to_cart save search share purchase convert sign_up subscribe other

config

object

selector

string

required

CSS selector for the page element(s) that trigger an Event

created

date-time

Creation date for this Event

description

string

A description for this Event

event_properties

array of objects

A set of user-defined data elements for the event. Metrics can filter on particular values of these properties.

event_properties

object

data_type

string

The type of data that can be accepted for this property.

boolean number string

name

string

The name of the property.

event_type

string

The type of this Event

custom click pageview classic_custom classic_click classic_pageview classic_engagement classic_revenue classic_mobile_tap classic_mobile_view classic_mobile_session_length classic_mobile_num_session

int64

The unique identifier of the Event

is_classic

boolean

Defaults to false

Whether or not this Event is a classic Event. If true, this Event is read-only

is_editable

boolean

Whether this Event may be edited

key

string

length ≤ 64

Unique string identifier for this Event within the Project

last_modified

date-time

The last time the Event was modified

name

string

A human readable name for this Event

page_id

int64

The Page ID associated with this Event

project_id

int64

The ID of this Event's parent Project

Response body

object

code

string

message

string

messages

object

Has additional fields

uuid

Response body

object

code

string

message

string

messages

object

Has additional fields

uuid

Response body

object

code

string

message

string

messages

object

Has additional fields

uuid

Response body

object

code

string

message

string

messages

object

Has additional fields

uuid

Updated 2 months ago

List all Events

Create an In-Page Event

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.optimizely.com/v2/events/event_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 2 months ago

List all Events

Create an In-Page Event

Optimizely Web Experimentation
API functions
Push
Tags
User
Wait for origin sync
Send events
Page
Opt out
Log
Extend cookie lifetime
Hold events
Disable
Disable cross origin
Event
Cookie domain
Bucket visitor
Add listener
Cookie expiration
Activate
Get
Visitor ID
Visitor
Utils
State
Session
Data
jQuery
DCP
Behavior

Optimizely API
Get started with Experimentation REST API
Projects
Update a Projectpatch
Read a Projectget
Create a Projectpost
List Projectsget
Campaigns
Get Campaign results as a CSVget
Get a sharable link for the campaign's results pageget
Get Campaign resultsget
Update a Campaignpatch
Read a Campaignget
Archive a Campaigndelete
Create a Campaignpost
List Campaignsget
Experiments
Get Experiment results as a CSVget
Get Experiment results time seriesget
Get a sharable link for the experiment's results pageget
Get Experiment resultsget
Update an Experimentpatch
Read an Experimentget
Archive an Experimentdelete
Create an Experimentpost
List Experimentsget
Audiences
Update an Audiencepatch
Read an Audienceget
Create an Audiencepost
List Audiencesget
Pages
Update a Pagepatch
Read a pageget
Archived a Pagedelete
Create a Pagepost
List Pagesget
Events
Update a Custom Eventpatch
Archive a Custom Eventdelete
Create a Custom Eventpost
Update an In-Page Eventpatch
Archive an In-Page Eventdelete
Create an In-Page Eventpost
Get Event by IDget
List all Eventsget
Attributes
Update an Attributepatch
Read an Attributeget
Archive an Attributedelete
Create an Attributepost
List Attributesget
Groups
Update an Exclusion Grouppatch
Get an Exclusion Groupget
Archive an Exclusion Groupdelete
Create an Exclusion Grouppost
List Exclusion Groupsget
Extensions
Update an Extensionpatch
Get an Extensionget
Archive an Extensiondelete
Create an Extensionpost
List Extensionsget
Plan
Get Plan & Usage information for all productsget
Scheduled Jobs
Update a Scheduled Jobpatch
Get a Scheduled Jobget
Archive a Scheduled Jobdelete
Create a Scheduled Jobpost
Get a list of Scheduled Jobsget
User
Get current User informationget
List Attributes
Update a List Attributepatch
Read a List Attributeget
Archive a List Attributedelete
Create a List Attributepost
Get list attributes by projectget
Sections
Update a Section by IDpatch
Read a Section of a Multivariate Testget
Archive a Section by IDdelete
Create a new Section in a Multivariate Testpost
Read all the Sections in a Multivariate Testget
Features
Update a Featurepatch
Read a Featureget
Archive a Featuredelete
Create a Featurepost
Get Features by Projectget
Subject Access Requests
Get Subject Access Requestget
Create a Subject Access Requestpost
List Subject Access Requestsget
Update a Subject Access Requestpost
Update a Subject Access Requestpatch
List Subject Access Requests by data source and statusget
Environments
Read the datafile of an Environmentget
Update an Environmentpatch
Read an Environmentget
Archive an Environmentdelete
Create an Environmentpost
Get Environments by Projectget
Search
Searchget
Change History
Retrieve changes for a project.get
Attribution
Get bucketing information for a visitorget
Export Credentials
Get aws credentials to access enriched events datasetget
Impressions Usage
Get Impressions Usage Summaryget
Get Impressions Usageget
Collaborators
List Collaborators who have not yet accepted the invitationsget
Invite Collaboratorspost
List Collaboratorsget
ExperimentSummary
Summaries of Experiments and Campaignsget
Reports
Get Experiment Result's Reportget
Webhooks
Update a Webhookpatch
Read a Webhookget
Delete a Webhookdelete
Create a Webhookpost
Get Webhooks by Projectget
Recommendations
Download a CSV with summary stats dataget
Download a CSV with all computed recommendations output dataget
Download a CSV with all current catalog dataget

Metrics Hub Service API
MetricSets
List Metric Sets by Metric idsget
Update a Metric Setpatch
Delete Metric Setsdelete
Create a Metric Setput
List Metric Setsget
Metrics
Delete a Metricdelete
Read a Metricget
Update a Metricpatch
Create a Metricpost
List Metricsget

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Get Event by ID

200Return Event specified by ID

401Invalid credentials

403You do not have permission to access specified Event

404Event not found

defaultUnexpected error