Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Events

Update an In-Page Event

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

patch/pages/{page_id}/events/{event_id}

Path parameters

page_idinteger required

The Page ID of the In-Page Event you want to change

event_idinteger required

The In-Page Event ID of the In-Page Event you want to change

Request body

archivedboolean

Whether or not to archive this Event

category'add_to_cart' | 'save' | 'search' | 'share' | 'purchase' | 'convert' | 'sign_up' | 'subscribe' | 'other'
descriptionstring

A description of this Event

keystring

Unique string identifier for this Event within the Project

namestring

A human readable name for this Event

page_idinteger

The Page ID associated with this Event

variation_specificboolean

Whether or not this Event is variation specific.

Example request

{
  "config": {
    "selector": ".menu-options"
  },
  "key": "add_to_cart",
  "name": "Add to Cart"
}

Response

Successfully updated the In-Page event

archivedboolean

Whether or not this Event is archived

category'add_to_cart' | 'save' | 'search' | 'share' | 'purchase' | 'convert' | 'sign_up' | 'subscribe' | 'other'
createdstring date-time

Creation date for this Event

descriptionstring

A description of this Event

event_type'click' required

The type of this Event

experiment_countinteger

Number of experiments that reference this Event across all statuses (running, paused, draft, archived). Computed by the upstream service.

idinteger

The unique identifier of the Event

is_classicboolean

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

is_editableboolean

Whether or not this Event may be edited

keystring

Unique string identifier for this Event within the Project

last_modifiedstring date-time

The last time the Event was modified

namestring required

A human readable name for this Event

page_idinteger

The Page ID associated with this Event

project_idinteger

The ID of this Event's parent Project

variation_specificboolean

Whether or not this Event is variation specific.

Example response

{
  "config": {
    "selector": ".menu-options"
  },
  "experiment_count": 3,
  "key": "add_to_cart",
  "name": "Add to Cart",
  "project_id": 1000
}