HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

Events

This topic describes events in Optimizely Data Platform (ODP).

Events describe Customer actions. Events are composed of a Type, Action, and additional metadata via 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 are Event Types while purchase, return, add_to_cart, detail are Event Actions.

Standard and Custom Events

ODP has two types of events: Standard & Custom.

πŸ“˜

Note

At minimum, events require an event type and an identifier to associate the event with a customer.

Standard Events

Standard Events are events that have a pre-defined event type/action and are expected by ODP to be accompanied with certain fields. The usage of these events makes the usage of ODP simpler for common use cases.

Standard Use Case Events

For common events, based on use case (for example, products, orders, ratings, surveys, loyalty, etc.), refer to the appropriate use case documentation:

Marketing & Channels

eCommerce

Loyalty & Rewards

Standard Generic Events

Account Events

type

action

account

login

account

logout

account

register

account

update

Page View Events

type

page

pageview

/products/12345

πŸ“˜

Note

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

Navigation Events

type

action

search_term

navigation

search

cameras

navigation

sort

navigation

filter

Custom Events

Custom Events are events for which you create the event type/action and choose which fields to use and/or create.

Example

type

action

venue_name

venue

visited

TD Garden

To begin sending events to ODP, refer to the specific documentation for your platform:

Reference

Active Events

❗️

Warning

This is only to be used for the rare case you have an event that is not triggered by a customer. Abuse of this functionality may result in a loss of data.

This is helpful for events like campaign sends, subscription and support ticket events generated by an agent where the customer was not the direct source of the event.

This field allows ODP to determine if an event was active or not. If it is set to true, then that is considered customer activity.

This means that the event will impact our calculation of Monthly Active Users (MAUs), it also allows us to exclude from certain engagement reporting like Customer Lifecycle when appropriate.

Automatic Active Events

🚧

Caution

If the field is left blank, we will set the value to true by default, meaning it is assumed that the event is active.

Field Display Name

Field Name

Field Type

Field Description

Is Active Event?

active_event

True / False boolean

Indicates whether this event should contribute to Monthly Active User (MAU) calculations. Is false if the event is not triggered directly by the customer. Examples include campaign sends and support tickets being closed. If not set, will be set to β€œtrue”, making the event active.

Event Type

Action

customer_discovered

campaign

consent

reachability

list

email

any action not open or click

push

any action not open or click

Some events are set to inactive by default (active_event = false).

πŸ“˜

Note

If needed, this can be overridden by a developer by including the field on the event payload.


Did this page help you?