Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Events

Get Event by ID

Get Event by ID

get/events/{event_id}

Path parameters

event_idinteger required

The Event ID of the Event you want to get

Query parameters

include_classicboolean

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

Response

Return Event specified by ID

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 for this Event

event_type'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'

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, this Event is read-only

is_editableboolean

Whether 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

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"
  },
  "description": "Item added to cart",
  "experiment_count": 3,
  "key": "add_to_cart",
  "name": "Add to Cart",
  "page_id": 5000,
  "project_id": 1000
}