Model: InPageEvent

1 min

Model Parameters

InPageEvent
- 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.

An Event that can occur only within the context of a specific Page (allowed in Web Projects only)