Events - Interactions
Use this reference to interpret interaction-related events provided using the Experiences SDK onEventTriggered callback. It lists the interaction event structure and explains each event_action and its associated values.
Events have the structure outlined in the table that follows.
Table structure
- Field: The field name.
- Field data: For fields with a variant type, this column specifies the name of the field data within the variant
- Type: The type of the field or field data (if the field is a variant). Possible types include Number, Varchar, or Boolean.
- Example: A sample value or instance of the field.
- Description: An explanation of the field's meaning, if necessary.
- From version: The SDK version from which this field started being reported.
- web/mobile: Indicates whether the field reports data only when a viewer is on web ("web"), mobile ("mobile"), or both (no entry).
- Options: Lists possible values for the field if it has a finite set of options.
Interaction events
| Field | Field data | Type | Example | Description | From version | web/mobile | Options |
|---|---|---|---|---|---|---|---|
| Interaction (Variant) | interaction_id | Varchar | 65957ba84f3459a17f1fdd1a | ||||
| Interaction (Variant) | interaction_text | Varchar | { " question " : " 🤔 " , " answers " : [ { " id " : " 65cfd9ab600e4a7532c41a1d " , " image " :null, " text " : " Moises Henriques " , " isCorrect " :true} | ||||
| Interaction (Variant) | interaction_type | Varchar | Poll | "", Quiz, null, Poll | |||
| Interaction (Variant) | interaction_selected_answer | Varchar | 65957ba84f3459a17f1fdd19 | The answer that the user choose | |||
| Interaction (Variant) | content_session_id | Varchar | 70f4bbba-d237-4cde-b2bf-068473d46976 | same value as the stories/moments session | |||
| Interaction (Variant) | content_id | Varchar | 664df23eb615f6b5a13e44ed | story_id/moment_id | |||
| Interaction (Variant) | content_type | Varchar | Moment | null, Story, story, Moment | |||
| Interaction (Variant) | content_title | Varchar | Loïc Badé with a Spectacular Defensive Act vs. Athletic Club | ||||
| Interaction (Variant) | content_page_id | Varchar | 6554d01e182ca9d8338dd101 | ||||
| Interaction (Variant) | content_extra_info | Varchar | null | null | |||
| Interaction (Variant) | audio_state | Varchar | Mute | Indicates whether the user viewed the interaction with or without sound | null, Unmute, Mute | ||
| Interaction (Variant) | playback_action_method | Varchar | Press | null, Press, Release |
In the table below, you'll find descriptions for each event_action, along with indicators showing whether the event_action reports a specific field (fields from the Interaction variant only).
- Note, that each event_action reports not only the fields listed in the table below, but also all generic fields, as described on the events page.
| event_action | interaction_view | interaction_answer | audio | share_click | playback_pause | playback_play |
|---|---|---|---|---|---|---|
| Description | This event will triggered when the user viewed the ad content | This event will triggered when the user clicked on the ad content | same logic as Stories | same logic as Stories | same logic as Stories | same logic as Stories |
| content_session_id | V | V | V | V | V | V |
| content_type | V | V | V | V | V | V |
| content_id | V | V | V | V | V | V |
| content_title | V | V | V | V | V | V |
| content_page_id | V | V | V | V | V | V |
| interaction_id | V | V | V | V | V | V |
| interaction_type | V | V | V | V | V | V |
| interaction_text | V | V | V | V | V | V |
| interaction_selected_answer | V | V | V | V | V | V |
| playback_action_method | V | V | V | V | V | V |
| audio_state | V | V | V | V | V | V |
Updated 5 months ago
Did this page help you?
