List all Events

1 min

GET

https://api.optimizely.com/v2/events

Get all Events for a Project. This endpoint lists all types of Events including Pageview Events which are stored as Pages. You can also get Goal objects from Optimizely Classic by setting the include_classic parameter to true.

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.
Default
1
project_idinteger<int64>required
Description
The ID of the Project you would like to list all Events for
Format
int64
include_classicboolean
Description
Whether or not to include classic Events in the list of Events. If this parameter is not provided it will default to false
Default
false

Responses

200List of Events for the supplied Project ID

Event[]
- archivedboolean
  Description
  Whether or not this Event is archived
- categoryEventCategories
  - namestring
- configInPageEventConfig
  - selectorstringrequired
    Example
    .menu-options
    Description
    CSS selector for the page element(s) that trigger an Event
- createdstring<date-time>
  Description
  Creation date for this Event
  Format
  date-time
- descriptionstring
  Example
  Item added to cart
  Description
  A description for this Event
- event_propertiesEventProperty[]
  Description
  A set of user-defined data elements for the event. Metrics can filter on particular values of these properties.
  - data_typestring<boolean | number | string>
    Description
    The type of data that can be accepted for this property.
    Allowed
    booleannumberstring
  - namestring
    Description
    The name of the property.
- event_typestring<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>
  Description
  The type of this Event
  Allowed
  customclickpageviewclassic_customclassic_clickclassic_pageviewclassic_engagementclassic_revenueclassic_mobile_tapclassic_mobile_viewclassic_mobile_session_lengthclassic_mobile_num_session
- idinteger<int64>
  Description
  The unique identifier of the Event
  Format
  int64
- is_classicboolean
  Description
  Whether or not this Event is a classic Event. If true, this Event is read-only
  Default
  false
- is_editableboolean
  Description
  Whether this Event may be edited
- keystring
  Example
  add_to_cart
  Description
  Unique string identifier for this Event within the Project
  Max Length
  64
- last_modifiedstring<date-time>
  Description
  The last time the Event was modified
  Format
  date-time
- namestring
  Example
  Add to Cart
  Description
  A human readable name for this Event
- page_idinteger<int64>
  Example
  5000
  Description
  The Page ID associated with this Event
  Format
  int64
- project_idinteger<int64>
  Example
  1000
  Description
  The ID of this Event's parent Project
  Format
  int64

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have access to Events in the specified Project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Project not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/events?per_page=25&page=1&project_id=integer%3Cint64%3E&include_classic=boolean' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/events?per_page=25&page=1&project_id=integer<int64>&include_classic=boolean", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/events?per_page=25&page=1&project_id=integer<int64>&include_classic=boolean")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/events?per_page=25&page=1&project_id=integer<int64>&include_classic=boolean"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of Events for the supplied Project ID
[
  {
    "archived": false,
    "category": "",
    "config": {
      "selector": ".menu-options"
    },
    "created": "",
    "description": "Item added to cart",
    "event_properties": [
      {
        "data_type": "",
        "name": ""
      }
    ],
    "event_type": "",
    "id": "",
    "is_classic": false,
    "is_editable": false,
    "key": "add_to_cart",
    "last_modified": "",
    "name": "Add to Cart",
    "page_id": 5000,
    "project_id": 1000
  }
]

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have access to Events in the specified Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Project not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}