Skip to content

Analytics on the Web SDK#

Event Types#

These are the various events which are triggered from within the SDK. These events are passed to the onUserActivityOccurred delegate method. Please see the StorytellerDelegate page for details on implementing delegate methods.

The available event types are as follows:

Click an event type in the list above to see:

  • The list of available events;
  • When each event is recorded; and
  • The event properties passed with each event.

Event Data#

OpenedReason#

The action which the user took to open the Story:

Value Description
storyListTap The user tapped the Story in the List
deepLink The user navigated directly to a Story url
swipe The user swiped left or right to change the Story
automaticPlayback The user completes the previous Page automatically, i.e. its timer expires
tap The user taps to navigate

or Clip:

Value Description
clipListTap The user tapped the Clip in the List
categoryListTap The user tapped on a Clip Category label
categoryBackTap The user tapped the back button in a Clip Category

DismissedReason#

The reason the Story/Clip was dismissed.

Value Description
backgroundTapped The user tapped the background to dismiss the Story (on desktop)
closeButtonTapped The user tapped close to dismiss the Story
swipedDown The user swiped down to dismiss the Story
swipedFinalStory The user swiped the final Story to dismiss it
swipedFirstStory The user swiped the first Story to dismiss it
skippedFinalPage The user tapped to skip the final Page of the final Story
backTapped The user tapped the browser back button to dismiss the Story view
completedFinalPage The user completed the final Page of the final Story
instanceMethod The player was dismissed programmatically using the dismissPlayer method
escapeKeyPressed The user pressed the Esc key to dismiss the Story