Events - Stories
Use this reference to interpret story-related events provided using the Experiences SDK onEventTriggered callback. It lists the story 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.
Stories events
| Field | Field data | Type | Example | Description | From version | web/mobile | Options |
|---|---|---|---|---|---|---|---|
| Story (Variant) | story_session_id | Varchar | 147-243-42-20 | Story’s session unique id | |||
| Story (Variant) | story_id | Varchar | 6643b5914e167da3d5a52b58 | Story unique id | |||
| Story (Variant) | story_title | Varchar | Tottenham vs. Manchester City | ||||
| Story (Variant) | story_page_id | Varchar | 6643b5914e167da3d5a52b57 | Current page id | |||
| Story (Variant) | story_page_index | Number | 5 | Current page number | |||
| Story (Variant) | story_page_count | Number | 6 | Total number of pages in the current story | |||
| Story (Variant) | story_page_navigation_type | Varchar | Automatic | Indicates whether the user accessed the story through automatic navigation or manual selection | Manual, Automatic, null | ||
| Story (Variant) | story_page_navigation_direction | Varchar | Forwards | Indicates whether the user navigated to the current story by moving Forward from the previous story or Backward | Forward, Backward, Forwards, Backwards, Close, null | ||
| Story (Variant) | story_start_trigger | Varchar | SingleStory | Method by which the user accessed the story | SingleStory, Share, Deeplink, Auto Play from Widget, Widget, "", Entry Point, Embedded Player in Viewport, Notification, null | ||
| Story (Variant) | story_start_id | Varchar | 6643b5914e167da3d5a52b58 | web | |||
| Story (Variant) | story_exit_trigger | Varchar | CTA Click | Method by which the user exited the story | Stories completed, Swipe Up, Skip, "", Back Button, CTA Click, Close Button, App Close, Swipe, Swipe Down, Escape Button, null, Automatic | ||
| Story (Variant) | content_duration_viewed | Number | 53081 | Total viewed time | |||
| Story (Variant) | story_page_duration | Number | 3.065034 | Story duration | |||
| Story (Variant) | story_page_duration_viewed_percent | Number | 0 | Percentage of the video duration that the user watched | |||
| Story (Variant) | playback_action_method | Varchar | Click | Release, Click, Press, null | |||
| Story (Variant) | audio_state | Varchar / Boolean | Mute | Indicates whether the user viewed the story with or without sound | Unmute, Mute | ||
| Story (Variant) | story_page_type | Varchar | Category/Article | Category/Article, Homepage, null | |||
| Story (Variant) | is_last_page | Boolean | TRUE | Indicates whether this story is on the final page | |||
| Story (Variant) | player_type | Varchar | Full Screen | Indicates whether the user viewed the story in full-screen or embedded mode | 0.1.93 | web | Full Screen, Embedded |
| Story (Variant) | gesture_type | Varchar | CTA Click | This field indicates whether the user interacted with the CTA by either clicking on it or swiping up to access it. | Android 1.3.3 iOS 1.5.2 | web | Swipe Up, CTA Click |
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 Story 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 | story_start | story_exit | story_page_start | story_page_exit | cta_click | audio | share_click | share_select | share_success | playback_pause | forced_playback_pause | playback_play | forced_playback_play | Expend |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Description | This event is triggered when a Story is opened by either: Clicking the Story in a widget or Swiping right/left to next Story or Skip from the last page to the next Story or from the first page to the previous Story | This event is triggered when a Story is closed by either: Clicking the close button to close the Story or Clicking the device UI back button to close the Story or Swiping down to close the Story or Moving to the or next/previous Story from a left/right swipe or Moving to the next/previous Story from a left/right click on the first/last Story Page or Moving to the next Story from fully completing the current Story or Clicking the CTA button | This event is triggered when the content of the Story Page starts playing | This event is triggered when a user exited the Story Page by either: Clicking the close button to close the Story or Clicking the device UI back button to close the Story or Swiping down to close the Story or Moving to the next/previous Story from a left/right swipe or Moving to the next/previous Story from a left/right click or Moving to the next Story Page from fully completing the current Story Page or Clicking the CTA button | 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 | Triggered when the user switches to viewing a story in full screen mode. | ||
| story_session_id | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_id | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_title | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_page_id | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_page_index | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_page_count | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_page_navigation_type | V | |||||||||||||
| story_page_navigation_direction | V | |||||||||||||
| story_start_trigger | V | |||||||||||||
| story_start_id | V | |||||||||||||
| story_exit_trigger | V | |||||||||||||
| content_duration_viewed | V | V | V | V | V | V | V | V | V | V | V | V | ||
| story_page_duration | V | V iOS 1.2.5 Android 1.2.7 | V | |||||||||||
| story_page_duration_viewed_percent | V | V | V | |||||||||||
| playback_action_method | V | V | ||||||||||||
| audio_state | V | V | V | V | V | V | V | V | V | V | V | V | V | V |
| story_page_type | V | V | V | V | V | V | V | V | V | V | V | V | ||
| is_last_page | V | V | V | V | V | V | V | V | V | V | V | V | ||
| player_type | V | V | V | V | V | V | V | V | V | V | V | V | ||
| story_name | V | V | V | V | V | V | V | V | V | V | V | |||
| gesture_type | V |
Updated about 2 months ago
Did this page help you?