Content Site Events

Common Attributes:

Attribute	Description
event_time	Timestamp of when the event occurred.
session_id	Identifier for the user session.
session_user_id	Identifier for the user within a session.
user_id	Identifier for the user.
device	Type of device used by the user.
location	User's location.
channel	The channel through which the event occurred.
metadata	Additional metadata associated with the event.
ab_flag	A/B testing flag.
search_term	The search term used by the user.

Search Event

Track this event when a user performs a search on the site, including interactions with the Autosuggest widget.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {},
  "ab_flag": "string",
  "event_type": "SearchEvent",
  "search_term": "string",
  "search_result_count": 0,
  "impressions": [
    {
      "product_id": "string",
      "rank": 0,
      "instock": true
    }
  ]
}

Attribute	Description
search_result_count	Number of search results.
impressions	List of products with details like product_id, rank, and instock status.

Autosuggest Event

Track this event when a user clicks on a suggestion in the Autosuggest widget.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {},
  "ab_flag": "string",
  "event_type": "AutoSuggestClick",
  "search_term": "string",
  "autosuggest_prefix": "string",
  "autosuggest_position": 0
}

Attribute	Description
autosuggest_prefix	Prefix used in autosuggest.
autosuggest_position	Position of the autosuggested item clicked.

PDP Event

Track this event when a user views a Product Detail Page (PDP).

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {
    "referrer": "alias"
  },
  "ab_flag": "string",
  "search_term": "string",
  "page_id": "string",
  "page_params": [
    {
      "field": "string",
      "values": ["string"]
    }
  ],
  "event_type": "PDPEvent",
  "product_id": "string",
  "click_position": 0
}

Attribute	Description
page_id	Identifier for the page.
page_params	Parameters associated with the page, such as field and values.
product_id	Identifier for the product on the PDP.
click_position	Position of the click on the page.

Page Click

Track this event when a user clicks on a page.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {
    "referrer": "alias",
    "widget_type": "widget name"
  },
  "ab_flag": "string",
  "search_term": "string",
  "event_type": "PageClick",
  "product_id": "string",
  "click_position": 0
}

Attribute	Description
widget_type	Type of widget clicked.
product_id	Identifier for the clicked product.
click_position	Position of the click on the page.

Scroll Event

Track this event when a user scrolls on a page.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {
    "referrer": "alias",
    "widget_type": "widget name",
    "action": "Up/Down",
    "page_name": "home"
  },
  "ab_flag": "string",
  "search_term": "string",
  "event_type": "ScrollEvent",
  "product_id": "string",
  "click_position": 0
}

Attribute	Description
widget_type	Type of widget scrolled.
action	Scroll action (Up/Down).
page_name	Name of the page being scrolled.
product_id	Identifier for the scrolled product.
click_position	Position of the click on the page.

Video View

This event is tracked when a user views a video.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {
    "referrer": "alias",
    "widget_type": "widget name",
    "play_duration": 120
  },
  "ab_flag": "string",
  "search_term": "string",
  "event_type": "VideoView",
  "product_id": "Video ID or URL"
}

Attribute	Description
play_duration	Duration of video playback.

Video Play

This event is tracked when a user plays or pauses a video.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {
    "referrer": "alias",
    "widget_type": "widget name",
    "play_duration": 120,
    "action": "play/pause",
    "play_position": 90
  },
  "ab_flag": "string",
  "search_term": "string",
  "event_type": "VideoPlay",
  "product_id": "Video ID or URL"
}

Attribute	Description
play_duration	Duration of video playback.
action	Action performed (play/pause).
play_position	Position where the video was played.

Video Completion

This event is tracked when a user completes viewing a video.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {
    "referrer": "alias",
    "widget_type": "widget name",
    "play_duration": 120
  },
  "ab_flag": "string",
  "search_term": "string",
  "event_type": "VideoCompletion",
  "product_id": "Video ID or URL"
}

Attribute	Description
play_duration	Duration of video playback.

Sort Event

This event is tracked when a user performs a sorting action.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {},
  "ab_flag": "string",
  "search_term": "string",
  "page_id": "string",
  "page_params": [
    {
      "field": "string",
      "values": ["string"]
    }
  ],
  "event_type": "SortEvent",
  "sort": "string"
}

Attribute	Description
page_id	Identifier for the page.
page_params	Parameters associated with the page, such as field and values.
sort	Type of sorting applied.

Filter Event

This event is tracked when a user applies filters to refine search results.

{
  "event_time": "2023-07-24T10:28:31.302Z",
  "session_id": "string",
  "session_user_id": "string",
  "user_id": "string",
  "device": "string",
  "location": "string",
  "channel": "string",
  "metadata": {},
  "ab_flag": "string",
  "search_term": "string",
  "page_id": "string",
  "page_params": [
    {
      "field": "string",
      "values": [
        "string"
      ]
    }
  ],
  "event_type": "FilterEvent",
  "filters": [
    {
      "name": "string",
      "field": "string",
      "values": [
        "string"
      ]
    }
  ]
}

Attribute	Description
page_id	Identifier for the page.
page_params	Parameters associated with the page, such as field and values.
filters	List of applied filters with details like name, field, and values.

Subscription Event

Indicates when a user subscribes to a service or newsletter.

{
  "event_time": "2024-04-16T08:00:00.000Z",
  "session_id": "abc123",
  "session_user_id": "user123",
  "user_id": "user123",
  "device": "mobile",
  "location": "USA",
  "channel": "website",
  "metadata": {
    "referrer": "homepage"
  },
  "ab_flag": "subscription_v2",
  "event_type": "Subscription"
}

Portfolio Adds Event

Records when a user adds an investment or asset to their portfolio.

{
  "event_time": "2024-04-16T10:30:00.000Z",
  "session_id": "ghi789",
  "session_user_id": "user789",
  "user_id": "user789",
  "device": "tablet",
  "location": "Canada",
  "channel": "app",
  "metadata": {
    "referrer": "profile_page"
  },
  "ab_flag": "portfolio_v2",
  "event_type": "PortfolioAdds",
  "product_id": "portfolio_item_123"
}

Sign up Event

Marks when a user creates a new account or registers for a service.

{
  "event_time": "2024-04-16T13:00:00.000Z",
  "session_id": "mno345",
  "session_user_id": "user345",
  "user_id": "user345",
  "device": "desktop",
  "location": "Germany",
  "channel": "website",
  "metadata": {
    "referrer": "landing_page"
  },
  "ab_flag": "signup_v3",
  "event_type": "SignUp"
}

Sign In Event

Indicates when a user logs into their account or accesses a platform.

{
  "event_time": "2024-04-16T14:15:00.000Z",
  "session_id": "pqr678",
  "session_user_id": "user678",
  "user_id": "user678",
  "device": "tablet",
  "location": "France",
  "channel": "app",
  "metadata": {
    "referrer": "profile_page"
  },
  "ab_flag": "signin_v2",
  "event_type": "SignIn"
}

Event Attended Event

Records when a user attends or participates in an event, either physical or virtual.

{
  "event_time": "2024-04-16T16:45:00.000Z",
  "session_id": "vwx234",
  "session_user_id": "user234",
  "user_id": "user234",
  "device": "desktop",
  "location": "India",
  "channel": "app",
  "metadata": {
    "referrer": "event_page"
  },
  "ab_flag": "event_attended_v1",
  "event_type": "EventAttended",
  "page_id": "event_page_123"
}