Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

Events

Describes events in Optimizely Data Platform (ODP).

Events describe actions your customers perform or actions that result in an update to their customer record such as viewing your web page or visiting your store in New York.

Compose events

Events are composed using a two-tier connection including a type and action. You can set additional metadata with fields on the event.

  • The event type is a categorical name associated with the event.
  • The event action is the activity a user did within that event type.

For example:

  • order and product would be event types
  • purchase, return, or add_to_cart would be actions

At minimum, events require an event type and an identifier to associate the event with a customer. The event() method automatically passes the VUID (cookie ID) to ODP. You can include additional identifiers, like email or phone number which will associate that cookie ID with the other identifiers. Refer to Overview of customer identity and resolution to learn more.

🚧

Important

All ODP events are immutable, meaning you can not change them after you upload them to ODP.

Standard events

A standard event is an event that has a predefined event type and action. Using standard events makes using ODP simpler for common use cases.

Reference and examples:

Account event

Set the event type to account to track your users actions for login, logout, register and update.

typeaction
accountlogin
accountlogout
accountregister
accountupdate

Pageview event

Set the event type to pageview to track which pages your user visits.

typepage
pageview/products/12345
📘

Note

The Web SDK automatically populates the page field when event type is pageview.

Wishlist

Set the event type to product to track a user adding or removing an item from a wishlist.

typeaction
productadd_to_wishlist
productremove_from_wishlist

Navigation events

Set the event type to navigation to track what your user's search.

typeactionsearch_term
navigationsearchcameras
navigationsort
navigationfilter

Custom events

A custom event is where you create the event type and action and choose additional fields to use.

Custom events display on the customer profile (Customers > Profiles) in ODP.

📘

Note

See how to Create custom fields. You must select Events from the Object Containing New Field drop-down list.

Example

typeactionvenue_name
venuevisitedTD Garden

Reference: