Create an In-Page Event

1 min

POST

https://api.optimizely.com/v2/pages/{page_id}/events

Create an Event that occurs in the context of a Page, such as measuring clicks

Path Parameters

page_idinteger<int64>required
Description
The Page ID of the Page you want to create an In-Page Event for
Format
int64

Body Parameters

bodyInPageEventrequired
Description
A string in JSON format that includes all the fields to create an In-Page 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
- descriptionstring
  Description
  A description of this Event
- event_typestring<click>required
  Description
  The type of this Event
  Allowed
  click
- keystring
  Example
  add_to_cart
  Description
  Unique string identifier for this Event within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- namestringrequired
  Example
  Add to Cart
  Description
  A human readable name for this Event
- variation_specificboolean
  Description
  Whether or not this Event is variation specific.

Responses

201

Return the created In-Page event

InPageEvent
Description
An Event that can occur only within the context of a specific Page (allowed in Web Projects only)
- 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
  Description
  A description of this Event
- event_typestring<click>required
  Description
  The type of this Event
  Allowed
  click
- experiment_countinteger<int64>
  Example
  3
  Description
  Number of experiments that reference this Event across all statuses (running, paused, draft, archived). Computed by the upstream service.
  Format
  int64
- 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, the Event is read-only
  Default
  false
- is_editableboolean
  Description
  Whether or not this Event may be edited
- keystring
  Example
  add_to_cart
  Description
  Unique string identifier for this Event within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- last_modifiedstring<date-time>
  Description
  The last time the Event was modified
  Format
  date-time
- namestringrequired
  Example
  Add to Cart
  Description
  A human readable name for this Event
- page_idinteger<int64>
  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
- variation_specificboolean
  Description
  Whether or not this Event is variation specific.

400Invalid Page ID or request body supplied

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

401Invalid credentials

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

403

You do not have permission to add an In-Page event

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

defaultUnexpected error

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

curl

curl --request POST \
     --url https://api.optimizely.com/v2/pages/{page_id}/events \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "config": {
     "selector": ".menu-options"
     },
     "event_type": "",
     "name": "Add to Cart"
     }'

javascript

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

var raw = JSON.stringify({
   "config": {
      "selector": ".menu-options"
   },
   "event_type": "",
   "name": "Add to Cart"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/pages/{page_id}/events", 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/pages/{page_id}/events")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "config": {
      "selector": ".menu-options"
   },
   "event_type": "",
   "name": "Add to Cart"
})

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

python

import requests
import json

url = "https://api.optimizely.com/v2/pages/{page_id}/events"

payload = json.dumps({
   "config": {
      "selector": ".menu-options"
   },
   "event_type": "",
   "name": "Add to Cart"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Return the created In-Page event
{
  "archived": false,
  "category": "",
  "config": {
    "selector": ".menu-options"
  },
  "created": "",
  "description": "",
  "event_type": "",
  "experiment_count": 3,
  "id": "",
  "is_classic": false,
  "is_editable": false,
  "key": "add_to_cart",
  "last_modified": "",
  "name": "Add to Cart",
  "page_id": "",
  "project_id": 1000,
  "variation_specific": false
}

400

// Invalid Page ID or request body supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

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

403

// You do not have permission to add an In-Page event
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

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