Analytics

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 StorytellerListViewDelegate page for details on implementing delegate methods.

Story Events

Opened Story

This event is recorded in the following scenarios:

  • When a user taps on a row item to open a story
  • When a story is loaded because the previous story finished
  • When a story is loaded because the user tapped to skip the last page of the previous story
  • When a user swipes left on a story to go to the next story
  • When a user swipes right on a story to go to the previous story
  • When a user is sent directly to a story via a deeplink

Opened Page

This event is recorded when as soon as a user sees content for a page

Dismissed Story

This event is recorded in the following scenarios:

  • When a user taps the close button to dismiss the story
  • When a user swipes down to dismiss the story
  • When a user taps back on their device UI to dismiss the story (Android only)
  • When a user taps to skip the last page of the final story - this dismisses the story and exits the Story View
  • When a user swipes left on the final story to dismiss the story
  • When a user swipes right on the first story to dismiss the story
  • When a user completes the final page of the final story and the story view is dismissed

Skipped Story

This event is recorded when:

  • a user swipes left to go to the next story

Completed Story

This event is recorded at the same time as OpenedPage for the final page in a story.

Swiped Up

This event is recorded in the following scenarios:

  • When a user swipes up on a page to open a link
  • When a user taps on the swipe up element of a page to open a link

Share Button Tapped

This event is recorded when a user taps the share button on a page

Previous Story

This event is recorded when:

  • a user swipes right to go to the previous story (unless this is the first story - in which case DismissedStory is fired instead)
  • a user taps back on the first page in a story (and this is not the first page is the first story)

Previous Page

This event is recorded when a user taps back to go to a previous page in the story

Voted Poll

This event is recorded when a user votes for a poll answer

Event Data

For each event, data is returned with details about the story and page involved as well as some extra properties with more information about what the user has done. The data is returned as a UserActivityData class with the following properties:

  • storyId: String? - the ID of the story for which the event occurred
  • storyTitle: String? - the title of the story for which the event occurred
  • storyIndex: Int? - the index of the story for which the event occurred in the row from which it was opened at the point it was opened - this is only included on openedStory events. Note: this value is 1-based
  • storyPageCount: Int? - the number of pages in the story
  • storyReadStatus: String? - whether the story was read or unread at the point the story was opened - this is only included on openedStory events. Note this will either be read or unread.
  • pageId: String? - the ID of the page for which the event occurred
  • pageIndex: Int? - the index of the page in the story for which the event occurred. Note: this value is 1-based
  • pageType: String? - the type of the page associated with the event. This can have the value image, video or poll
  • pageHasSwipeUp: Bool? - whether the page associated with the event contains a swipe up link
  • pageSwipeUpText: String? - if the page associated with the event has a swipe up link, the text call to action associated with that link
  • pageSwipeUpUrl: String? - if the page associated with the event has a swipe up link, the URL which is linked to from the swipe up
  • openedReason: String? - only included on openedStory events. Possible values are storyRowTap (the user tapped the story in the story row to open the story); deepLink (the user navigated directly to the story url); swipe (the user swiped left or right to change the current story); navigation (either the user tapped to open the next/previous page, or the page finished playing and the next page was shown)
  • dismissedReason: String? - only included on dismissedStory events - possible values are closeButtonTapped (the user tapped close to dismiss the story); swipedDown (the user swiped down to dismiss the story); navigatedFinalPage (the user either completed or skipped the final page of a story); swipedFirstStory (the user swiped right on the first story); swipedFinalStory (the user swiped right on the final story);
  • durationViewed: Float? - In milliseconds, the duration the user viewed the story view for (measured from the most recent openedStory event with an Opened Reason of storyRowTap or deepLink). This timer is reset after any dismissedStory events
  • pagesViewedCount: Int? - the total number of pages a user has viewed since the most recent openedStory event with an Opened Reason of storyRowTap or deepLink. This count is reset after any dismissedStory events
  • categories - only included on openedStory events. List of categories assigned to the story for which the event occurred.
  • pollAnswerId - only included on votedPoll events. ID of the poll answer voted for by the user.
PREVIOUS
Forward Arrow