Model: Event

1 min

Model Parameters

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
- 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, 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
- variation_specificboolean
  Description
  Whether or not this Event is variation specific.