Events - Moments
Use this reference to interpret moment-related events provided using the Experiences SDK onEventTriggered callback. It lists the moment event structure 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.
Moments events
| Field | Field data | Type | Example | Description | From version | web/mobile | Options |
|---|---|---|---|---|---|---|---|
| Moment (Variant) | moments_session_id | Varchar | 7d5bc3f4-41c5-4353-a536-cf266e6b05b5 | The moment’s session unique id | |||
| Moment (Variant) | moment_id | Varchar | 6551fc95f81351d67b991eb1 | Moment unique id | |||
| Moment (Variant) | moment_title | Varchar | Top Fours from India vs. England | ||||
| Moment (Variant) | moment_index | Number / Varchar | 1 | The moment’s index at the page. | |||
| Moment (Variant) | moment_navigation_type | Varchar | Manual | Indicates whether the user accessed the moment through automatic navigation or manual selection. | Manual, null | ||
| Moment (Variant) | moment_navigation_direction | Varchar | Forward | Indicates whether the user navigated to the current moment by moving Forward from the previous moment or Backward. | Backward, Forward, Close, null | ||
| Moment (Variant) | moment_start_trigger | Varchar | Widget | The reason how the user entered the moment | Deeplink, Auto Play from Widget, Share, Widget, Entry Point, Notification, null | ||
| Moment (Variant) | moment_exit_trigger | Varchar | Back Button | The reason how the user exited the moment | Back Button, Close Button, Swipe, App Close, null | ||
| Moment (Variant) | moment_duration | Number | 119.583 | Video duration | |||
| Moment (Variant) | moment_duration_viewed_percent | Number | 86 | Percent of the video duration that the user saw | |||
| Moment (Variant) | playback_action_method | Varchar | Click | Click, Press, null | |||
| Moment (Variant) | audio_state | Varchar | Mute | If the user saw the moment with or with out voice | Unmute, Mute | ||
| Moment (Variant) | loop_Number | Number | 0 | How many times the user saw this moment |
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 Moment 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 | moments_playlist_start | moments_playlist_exit | moment_start | moment_exit | cta_click | like | unlike | audio | share_click | share_select | share_success | playback_pause | forced_playback_pause | playback_play | forced_playback_play |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Description | when a user enter a moments playlist | when a user exits a moments playlist | when a user starts viewing a specific moment (including loops, i.e every loop should send a new event) | when a user exits a specific moment (either leaves the entire playlist or move to the next/previous moment or clicks the CTA) | This event is triggered when a user clicks on the CTA button | This event is triggered when a user changes the state of the audio | This event is triggered when a user clicks on button to share and if the share was successful then another event is triggered | This event is triggered when a user paused/play the playback: dedicated button or press and hold the screen - pause or release the hold - play | This event is triggered when the app automatically pauses/plays the playback | This event is triggered when a user paused/play the playback: dedicated button or press and hold the screen - pause or release the hold - play | This event is triggered when the app automatically pauses/plays the playback | ||||
| moments_session_id | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| moment_id | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| moment_title | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| moment_index | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| moment_navigation_type | V | ||||||||||||||
| moment_navigation_direction | V | ||||||||||||||
| moment_start_trigger | V | ||||||||||||||
| moment_exit_trigger | V | ||||||||||||||
| moment_duration | V iOS 1.2.5 Android 1.2.7 | V | |||||||||||||
| moment_duration_viewed_percent | V | ||||||||||||||
| playback_action_method | V | V | V | V | |||||||||||
| audio_state | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| loop_number | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
Updated about 2 months ago
Did this page help you?