Semantic Events

Introduction

When sending Events into Fanplayr 360 any value can be used for an Event name (Custom Event), but if you use one of our supported Semantic Events it will add extra automatic functionality to Insights and Profiles.

Any Event supports both Custom and Semantic Attributes, but many Semantic Events require specific Semantic Attributes to support Fanplayr 360 features.

Understanding Event Documentation

Each Semantic Event is documenated with:

• A description

• Links to any Semantic Attributes used

• Interface Tab: A TypeScript style definition of the Event

• JavaScript API Tab: An example of how to call this event from JS

• Custom API Tab: An example of the message structure when using the Custom API

Custom API examples include <EVENT_MESSAGE_PROPERTIES>. This represents the common properties that should be sent along with each message.

Example

Interface

interface Event {
    event: 'EVENT_NAME',
    properties: {
        customAttribute: string
        $product: Product
    } 
}

JavaScript API

fp360.track('EVENT_NAME', {
    customAttribute: "value", // custom attribute
    $product: { ... } // semantic Product
})

Custom API

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "EVENT_NAME",
  "properties": {
    "customAttribute": "value", // custom attribute
    "$product": { ... } // semantic Product
  }
}

Semantic Events

• E-Commerce

  • Product Viewed

  • Product List Viewed

  • Product Added

  • Product Removed

  • Cart Viewed

  • Checkout Started

  • Checkout Step Viewed

  • Checkout Step Completed

  • Order Completed

  • Searched

  • Discount Code Added

  • Discount Code Removed

  • Cart Abandoned

• Messaging

  • Message Sent

  • Message Bounced

  • Message Errored

  • Message Reported

  • Message Delivered

  • Message Viewed

  • Message Interacted

  • Message Subscribed

  • Message Unsubscribed

  • Message Consent Requested

  • Message Consent Granted

  • Message Consent Denied

• Other

  • Session Started

  • Session Ended

  • Location Visited

  • Offline Purchase Completed

  • Purchase Returned

  • Widget Viewed

  • Widget Interacted

  • Offer Viewed

  • Recommendation Viewed

  • Recommendation Clicked

  • Recommendation Added

  • Recommendation Purchased