Analytics

Table of Contents

1. Event Types
2. Story Events
3. Clip Events
4. Card Events
5. Ad Events
6. Playback Events
7. Sheet Events
8. Search Events
9. Event Data

Event Types

These are the various events which are triggered from within the SDK. Each event is a member of the StorytellerUserActivity.EventType enumeration. Please see the StorytellerDelegate page for details on how to bind to these events.

In the below discussion, "completing" a Page refers to allowing the timer to expire - so this would correspond to watching all of an Image Page for the duration set for it (default 15s) or watching all of a video.

Story Events

The following properties are included in Story-related events:

• airplayEnabled
• captionsEnabled
• contentLength
• currentCategory
• eyebrow
• isMuted
• metadata
• pageActionText
• pageActionType
• pageActionUrl
• actionLinkId
• pageHasAction
• pageId
• pageIndex
• pageTitle
• pageType
• storyDisplayTitle
• storyId
• storyPageCount
• storyPlaybackMode
• storyTitle
• context

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 deep link

Whenever an Opened Story event occurs, additional event data specific to this event includes storyReadStatus, categories, categoryDetails, storyIndex, and openedReason.

Opened Page

This event is recorded whenever a user views content from a page.

Opened Page is one of the most important events to track as it is equal to a video start, one of the most important measures of engagement. By tracking this event, you can monitor valuable information about user engagement with your app.

Whenever an Opened Page event occurs, additional event data specific to this event includes openedReason.

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 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

Whenever a Dismissed Story event occurs, additional event data specific to this event includes dismissedReason, durationViewed, and pagesViewedCount.

Skipped Story

This event is recorded when a user swipes left to go to the next story (not on the last page).

Note: This event is not fired when the user swipes on the last page of a story. In that case, the user has consumed all pages and is naturally moving to the next story or dismissing the player, which is not considered a "skip".

Skipped Page

This event is recorded when a user taps to go to the next page before completing the current page.

Completed Story

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

Completed Page

This event is recorded when a user watches a page to completion (i.e. the timer for that page finishes.)

Action Button Tapped

This event is recorded when a user taps an action button on a page to open a link.

Whenever an Action Button Tapped event occurs, additional event data specific to this event includes actionText.

Share Button Tapped

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

Whenever a Share Button Tapped event occurs, additional event data specific to this event includes shareMethod.

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 in the first story)

Previous Page

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

Share Success

This event is recorded when a user selects a sharing method from the system dialog.

Whenever a Share Success event occurs, additional event data specific to this event includes shareMethod.

Voted Poll

This event is recorded when user votes in a poll.

Whenever a Voted Poll event occurs, additional event data specific to this event includes pollAnswerId.

Trivia Quiz Question Answered

This event is recorded when a user answers a question in a trivia quiz.

Whenever a Trivia Quiz Question Answered event occurs, additional event data specific to this event includes triviaQuizId, triviaQuizTitle, triviaQuizQuestionId, and triviaQuizAnswerId.

Trivia Quiz Completed

This event is recorded when a user completes a trivia quiz.

Whenever a Trivia Quiz Completed event occurs, additional event data specific to this event includes triviaQuizId, triviaQuizTitle, and triviaQuizScore.

Story Instructions Screen Viewed

This event is recorded when:

• The Story instruction screen appears to users

Whenever a Story Instructions Screen Viewed event occurs, additional event data specific to this event includes storyReadStatus and openedReason.

Muted Story

This event is recorded when:

• A user mutes a Story by toggling the mute button, adjusting device volume controls, or using the UI mute button

Unmuted Story

This event is recorded when:

• A user unmutes a Story by toggling the mute button, adjusting device volume controls, or using the UI mute button

Clip Events

The following properties are included in all Clip-related events:

• airplayEnabled
• captionsEnabled
• categories
• categoryDetails
• clipActionText
• clipActionType
• clipActionUrl
• actionLinkId
• clipCollectionCount
• clipFeedType
• clipHasAction
• clipHasSecondaryActions
• clipId
• clipIndex
• clipSecondaryActionTypes
• clipSecondaryActionUrls
• clipSecondaryActionsText
• clipTitle
• contentLength
• isLive
• isMuted
• metadata

The following additional properties may be included when available:

• eyebrow
• collection
• collectionTitle
• categoryId
• categoryName
• context

Opened Clip

This event is recorded when:

• a user taps on a row or grid item to open a clip
• a user swipes up to the next clip
• a user swipes down to the previous clip
• a user is sent directly to a clip via a call to openCollection
• a user is sent directly to a clip via a deep link
• a user opens a Category and navigates to a new Clip or moves back to a previous Category
• a user dismisses the last Category (by pressing back or swiping right) and returns to the top-level Collection
• a user opens embedded Clips for the first time.
• a user pulls to refresh at the top of Embedded Clips.
• a user is viewing a Collection with "For You/Following" enabled and switches between "For You" and "Following".

Whenever an Opened Clip event occurs, additional event data specific to this event includes openedReason.

Dismissed Clip

This event is recorded when:

• a user taps on the back button in the top-left to exit the Clips player (and is at the top of the stack of Clip Categories)

This event does not fire when the user is not at the top of the Clip Category stack. Whenever a Dismissed Clip event occurs, additional event data specific to this event includes dismissedReason, durationViewed, clipsViewed, and loopsViewed.

Next Clip

This event is recorded when:

• a user swipes up to go to the next clip

Previous Clip

This event is recorded when:

• a user swipes down to go to the previous clip

Completed Loop

This event is recorded when:

• a user completes a loop of a clip

Whenever a Completed Loop event occurs, additional event data specific to this event includes completionType.

Note: For live clips this event will never be fired.

Action Button Tapped

This event is recorded when:

• a user taps the primary action button at the bottom of a Clip
• a user taps any secondary action buttons above the clip title
• a user swipes left on a clip to open the relevant action

Whenever an Action Button Tapped event occurs, additional event data specific to this event includes actionText, actionClass, actionIndex, tappedClipActionText, tappedClipActionUrl, and tappedClipActionType.

Share Button Tapped

This event is recorded when:

• a user taps the share button on a clip

Share Success

This event is recorded when:

• a user selects and successfully shares a page from the system dialog

Whenever a Share Success event occurs, additional event data specific to this event includes shareMethod.

Paused Clip

This event is recorded when:

• a user taps on the screen whilst a clip is playing to pause the clip - it does not fire when a clip is paused automatically by sharing or following an action

Note: For live clips this event will never be fired, as pausing/resuming live clips is not supported.

Resumed Clip

This event is recorded when:

• a user taps a clip that is paused to resume playback - it does not fire when a clip is resumed automatically

Note: For live clips this event will never be fired, as pausing/resuming live clips is not supported.

Scrubbed Clip

This event is recorded when:

• a user scrubs the clip to a different position by dragging the clip progress bar

Whenever a Scrubbed Clip event occurs, additional event data specific to this event includes openedReason, startPosition, endPosition, and scrubDirection.

Liked Clip

This event is recorded when:

• a user likes a clip by tapping the like button when they do not currently like the clip

Unliked Clip

This event is recorded when:

• a user unlikes a clip by tapping the like button when they currently like the clip

Finished Clip

This event is recorded when:

• Dismissed Clip is fired
• Next Clip is fired
• Previous Clip is fired
• Opened Category is fired
• The clip reaches the end and starts a new loop
• A user is viewing a Collection with "For You/Following" enabled and switches between "For You" and "Following"

Whenever a Finished Clip event occurs, additional event data specific to this event includes loopsViewed, durationViewed, and completionType.

Opened Category

This event is recorded when:

• a user taps a category at the bottom of the Clips Player to open a new Category
• a user opens a category by navigating back from another category

Note: This event is not fired when opening the top level of a collection - only when navigating to a specific category.

Dismissed Category

This event is recorded when:

• a user navigates back using the back button to the previous category.

This event does not fire when dismissing the top level collection

Follow Category

This event is recorded when:

• a user taps the plus button under the follow category button of the Clips Player
• a user taps the follow button at the top right of the Followable Category screen and the category was not followed

Unfollow Category

This event is recorded when:

• a user taps the checkmark button under the follow category button of the Clips Player
• a user taps the follow button at the top right of the Followable Category screen and the category was followed

Followable Category Tapped

This event is recorded when:

• a user taps the follow category button of the Clips Player to open the Followable Category screen
• a user swipes left from the right edge of the screen on a Clip with a Followable Category and opens the Followable Category screen

Enable Captions

This event is recorded when:

• a user taps the button to enable Closed Captions in the Clips Player

Disable Captions

This event is recorded when:

• a user taps the button to disable Closed Captions in the Clips Player

Muted Clip

This event is recorded when:

• A user mutes a Clip by toggling the mute button, adjusting device volume controls, or using the UI mute button

Unmuted Clip

This event is recorded when:

• A user unmutes a Clip by toggling the mute button, adjusting device volume controls, or using the UI mute button

Followable Category Limit Shown

This event is recorded when:

• the alert dialogue box associated with the Followable Category Limit is shown

Whenever a Followable Category Limit Shown event occurs, additional event data specific to this event includes followableCategoryLimitDialogue, followableCategoryLimitActionText, and followableCategoryLimitActionUrl.

Followable Category Limit Action Button Tapped

This event is recorded when:

• a user taps on the customisable action button in the Followable Category Limit Dialogue Box

Whenever a Followable Category Limit Action Button Tapped event occurs, additional event data specific to this event includes followableCategoryLimitDialogue, followableCategoryLimitActionText, and followableCategoryLimitActionUrl.

Followable Category Limit Dismissed

This event is recorded when:

• a user dismisses the Followable Category Limit Dialogue Box by tapping the cancel action button

Whenever a Followable Category Limit Dismissed event occurs, additional event data specific to this event includes followableCategoryLimitDialogue, followableCategoryLimitActionText, and followableCategoryLimitActionUrl.

Card Events

The following properties are included in all Card-related events:

• cardActionType
• cardActionUrl
• cardAspectRatio
• cardBackgroundType
• cardCollectionId
• cardId
• cardIndex
• cardSubtitle
• cardTitle
• categories
• categoryDetails
• hasButton
• isLive
• context
• actionLinkId

Card Viewed

This event is recorded when:

• a Storyteller Card appears on screen, either by scrolling to it or opening a view where its visible

Card Tapped

This event is recorded when:

• a user taps on the Storyteller Card view

Ad Events

The following properties are included in all Ad-related events:

• actionText
• actionType
• actionUrl
• adFormat
• adId
• adIndex
• adPlacement
• adResponseIdentifier
• adStrategy
• adType
• advertiserName
• airplayEnabled
• categories
• categoryDetails
• contentLength
• currentCategory
• hasAction
• isMuted
• context

For Story Ad events specifically, additional common fields include:

• pageActionText
• pageActionType
• pageActionUrl
• pageHasAction
• pageType
• storyPlaybackMode

For Clip Ad events specifically, additional common fields include:

• clipFeedType
• clipIndex
• collection
• collectionClipCount
• loopsViewed

Opened Ad

Stories

This event is recorded when:

• an ad is loaded because the previous story finished
• a user swipes left on a story to go to the next story and an ad appears
• a user swipes right on a story to go to the previous story and an ad appears

Whenever an Opened Ad event occurs, additional event data specific to this event includes adView and openedReason.

Clips

This event is recorded when:

• a user swipes up on a clip to go to the next clip and an ad should appear next
• a user swipes down on a clip to go to the previous clip and an ad should appear next
• an ad completes a loop and begins playing again from the start

Information about Ad View is only sent to client delegates on an OpenedAd event.

Whenever an Opened Ad event occurs, additional event data specific to this event includes adView and openedReason.

Dismissed Ad

Stories

This event is recorded when a user:

• taps close to dismiss the ad
• swipes down to dismiss the ad
• taps back on their device UI to dismiss the ad (Android only)
• taps to skip the ad if the ad is the last page in the current set of stories
• swipes left on the ad to skip it if the ad is the last page in the current set of stories
• completes the ad if the ad is the last page in the current set of stories

Whenever a Dismissed Ad event occurs, additional event data specific to this event includes durationViewed, dismissedReason and pagesViewedCount.

Clips

This event is recorded when a user:

• taps the back button to exit the clips player when an ad is being shown

Whenever a Dismissed Ad event occurs, additional event data specific to this event includes durationViewed, and clipsViewed.

Skipped Ad

Stories

This event is recorded when a user:

• swipes left to go to the next story before completing the current ad
• taps to go to the next page on an ad before completing the current ad

Clips

This event is recorded when:

• a user swipes up to go to the next clip
• a user swipes down to go the previous clip

Ad Action Button Tapped

Stories

This event is recorded when a user:

• swipes up on an ad to open a link
• taps on the swipe up element of an ad to open a link

Clips

This event is recorded when a user:

• taps the action button at the bottom of an ad displayed in clips
• swipes left on a clip to open the relevant action

Finished Ad

Stories

This event is recorded at the same time as Dismissed Ad, Skipped Ad and Viewed Ad Page Complete and gives an easier way to determine when an ad finishes for any reason.

Whenever a Finished Ad event occurs, additional event data specific to this event includes adView.

Clips

This event is recorded at the same time as DismissedAd, or SkippedAd.

Whenever a Finished Ad event occurs, additional event data specific to this event includes adView.

Paused Ad

Stories

This event is recorded when a user pauses a page within an ad by pressing and holding on the page.

Clips

This event is recorded when a user pauses a clip which is an ad by tapping the screen. It does not fire when a clip is paused automatically for sharing or following an action.

Resumed Ad

Stories

This event is recorded when a user resumes playing a page within an ad by releasing their long press which paused the ad.

Clips

This event is fired when a clip which is an ad is paused and a user taps the screen to resume playback. It does not fire when a clip is resumed automatically.

Viewed Ad Page First Quartile

This event is recorded when a user reaches 1/4 of the way through the duration of a page or clip which is an ad.

For clip ads (which loop), it fires for each loop of the clip.

Viewed Ad Page Midpoint

This event is recorded when a user reaches halfway through the duration of a page or clip which is an ad.

For clip ads (which loop), it fires for each loop of the clip.

Viewed Ad Page Third Quartile

This event is recorded when a user reaches 3/4 of the way through the duration of a page or clip which is an ad.

For clip ads (which loop), it fires for each loop of the clip.

Viewed Ad Page Complete

This event is recorded when a user reaches the end of the duration for a page or clip which is an ad.

For clip ads (which loop), it fires for each loop of the clip.

Muted Ad

This event is recorded when:

• A user mutes an Ad (in either Stories or Clips) by toggling the mute button, adjusting device volume controls, or using the UI mute button

Unmuted Ad

This event is recorded when:

• A user unmutes an Ad (in either Stories or Clips) by toggling the mute button, adjusting device volume controls, or using the UI mute button

Playback Events

The following properties are included in all Playback-related events:

• isMuted
• pageActionText
• pageActionUrl
• pageHasAction
• pageId
• pageIndex
• pageTitle
• pageType
• storyDisplayTitle
• storyId
• storyIndex
• storyPlaybackMode
• storyTitle
• context

Ready to Play

This event is called once per video page at the point when the video player has been loaded.

Media Started

This event is called once per video page at the point when the video starts to play for the first time.

Buffering Started

This event is called on video pages whenever the video starts to buffer.

Whenever a Buffering Started event occurs, additional event data specific to this event includes isInitialBuffering.

Buffering Ended

This event is called on video pages whenever the video finishes buffering.

Note: There should be at most one Ready to Play event and one Media Started event for every page. There may be multiple Buffering Started/Buffering Ended pairs of events for an individual page. There may not always be a Buffering Ended event for every Buffering Started event as the user may choose to exit the page during buffering.

Whenever a Buffering Ended event occurs, additional event data specific to this event includes isInitialBuffering and timeSinceBufferingBegan.

Sheet Events

The following properties are included in all Sheet-related events:

• actionText
• captionsEnabled
• categories
• categoryDetails
• clipActionText
• clipActionType
• clipActionUrl
• clipFeedType
• clipHasAction
• clipId
• clipIndex
• clipTitle
• collection
• collectionClipCount
• containerTitle
• currentCategory
• isLive
• isMuted
• pageActionText
• pageActionType
• pageActionUrl
• pageHasAction
• pageId
• pageIndex
• pageTitle
• pageType
• searchFilter
• searchSort
• searchTerm
• sheetId
• sheetSize
• sheetTitle
• storyId
• storyIndex
• storyPageCount
• storyTitle
• context

Opened Sheet

This event is recorded when a user opens a Sheet.

Whenever an Opened Sheet event occurs, additional event data specific to this event includes openedReason.

Dismissed Sheet

This event is recorded when a user closes a Sheet.

Search Events

The following properties are included in all Search-related events:

• categories
• categoryDetails
• currentCategory
• isSuggestion
• searchFilter
• searchFrom
• searchSort
• searchTerm

When search is opened from a Story context, additional properties include:

• pageActionText
• pageActionUrl
• pageHasAction
• pageId
• pageIndex
• pageTitle
• pageType
• storyDisplayTitle
• storyId
• storyIndex
• storyPageCount
• storyPlaybackMode
• storyReadStatus
• storyTitle
• context

When search is opened from a Clip context, additional properties include:

• clipActionText
• clipActionUrl
• clipHasAction
• clipId
• clipIndex
• clipTitle
• collection
• context

Opened Search

The openedSearch event is recorded when:

• A user taps on Search from a Story within the Story player
• A user taps on Search from a Clip within the Clip player
• The Storyteller.shared.openSearch() function is called

Dismissed Search

The dismissedSearch event is recorded when a user taps the 'X' button to exit the Search interface.

Whenever an Dismissed Search event occurs, additional event data specific to this event includes dismissedReason.

Performed Search

The performedSearch event is recorded when:

• A user taps the 'Search' icon after entering a term in the Search bar (whether manually or by tapping the 'arrow' icon beside a Search suggestion to populate the search bar)
• A user taps the 'Search' icon beside a Search suggestion. The Search is then performed with the suggestion as the term.
• A user taps 'Apply filters' from the filters interface.

Opened Filters

The openedFilters event is recorded when, after a user has performed as Search, they press the 'Filter' icon to bring up the filter interface.

Note: That filters can only be applied after the initial search has been performed.

Dismissed Filters

This event is recorded when a user, after calling up the 'Filters' interface, swipes down to exit the interface without applying any.

Used Suggestion

The usedSuggestion event is recorded when:

• A user taps the 'arrow' icon beside a Search suggestion to populate the Search bar. This does not trigger any other event, and the user may amend the Search bar input before performing a Search.
• A user taps the 'Search' icon beside a Search suggestion. This simultaneously triggers a PerformedSearch event, above.

Whenever a Used Suggestion event occurs, additional event data specific to this event includes initialInput.

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 StorytellerUserActivityData class with the following properties:

Story ID

The storyId: String? is the ID of the story for which the event occurred.

Story Title

The storyTitle: String? is the title of the story for which the event occurred.

Story Display Title

The storyDisplayTitle: String? is the display title of the Story for which the event occurred.

Story Index

The storyIndex: Int? is 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.

Story Page Count

The storyPageCount: Int? is the number of pages in the story.

Story Read Status

The storyReadStatus: String? is 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.

Page ID

The pageId: String? is the ID of the page for which the event occurred.

Page Index

The pageIndex: Int? is the index of the page in the story for which the event occurred.

Note: This value is 1-based.

Page Type

The pageType: String? is the type of the page associated with the event. This can have the value image, video or poll.

Story Playback Mode

The storyPlaybackMode: String? value states if the story was opened during the list or in the single story mode (Storyteller static method.) This is included for all events. The values for this are either list or singleStory.

Page Has Action

The pageHasAction: Bool? value states whether the page associated with the event contains an action.

Page Action Type

The pageActionType: String? is the type of the action on the page.

Page Action Text

The pageActionText: String? is the text call to action if the page has an action.

Page Action URL

The pageActionUrl: String? is the URL for the link if the page has an action.

Action Link ID

The actionLinkId: String? is the unique identifier of the action associated with the current story page, clip or card. This is not included for Ad events.

Opened Reason

The openedReason: String? value states how the user opened a Story or Clip. The possible values for this are: - storyListTap: The user tapped the Story in the Story row. - clipListTap: The user tapped the Clip in a Clip list. - deepLink: openStory or openPage was called to open the Story. - swipe: The user swiped left or right to change the current Story. - automaticPlayback: The user completed the previous Page. - card: The user taps on a Card. - clipActionButton: The user clicked on an action button in the Clips player. - pageActionButton: The user clicked on the action button in the Story player. - tap: The user tapped on the next or previous Story Page to navigate to this page. - instanceMethod: Storyteller.shared.openStory(id:) or Storyteller.shared.openPage(id:) was called to open a Story or a Page. - loop: The user completes a loop of a Clip naturally or by scrubbing to the end of the Clip's duration.

openedReason is only included on OpenedStory, OpenedClip, OpenedPage, StoryInstructionsScreenViewed, CompletedLoop, OpenedAd and OpenedSheet events.

Dismissed Reason

The dismissedReason: String? value states the way the user dismissed a story or clip. The possible values for this are closeButtonTapped (the user tapped close to dismiss the story); swipedDown (the user swiped down to dismiss the story); swipedFirstStory (the user swiped the first story to dismiss it); swipedFinalStory (the user swiped the final story to dismiss it); skippedFinalPage (the user tapped to skip the final page of the final story); completedFinalPage (the user completed the final page of the final story) and backButtonTapped (the user tapped the back button to dismiss the clip).

dismissedReason is only included on DismissedStory and DismissedClip events.

Duration Viewed

The durationViewed: Float? is the duration the user viewed the story or clip for in milliseconds. This is measured from the most recent OpenedStory or OpenedClip event with an Opened Reason of storyRowTap, deepLink, card, pageActionButton, clipActionButton or clipsListTap.

This timer is reset after any DismissedStory or DismissedClip events.

For FinishedClip, Duration Viewed is the duration the user viewed the clips player for in milliseconds. This is measured from the most recent OpenedClip event with an Opened Reason of swipe.

Pages Viewed Count

The pagesViewedCount: Int? is the total number of pages a user has viewed since the most recent OpenedStory event with an Opened Reason of storyRowTap, pageActionButton, clipActionButton, card or deepLink. This count is reset after any DismissedStory events.

Content Length

The contentLength: Int? is the total duration of the page content in seconds.

Share Method

The shareMethod: String? is the component name of the app which the user has selected for sharing.

Advertisers Name

The advertiserName: String? is the name of the advertiser for a particular ad. This is only included for ad events.

Ad ID

The adId: String? is the ad ID if an event is associated with an ad.

Ad View

The adView: View? is the view the ad is rendered in. This is only included for OpenedAd and FinishedAd events.

Ad Type

The adType: String? is the type of component on which the ad is displayed. This can have values stories or clips.

Ad Format

The adFormat: String? represents the format of the Ad that was displayed. Possible values can be customNative, native, banner.

Ad Placement

The adPlacement: String? represents the placement of the ad. It can be either Between Stories, Between Pages or Between Clips. This is only included for ad events.

Ad Strategy

The adStrategy: String? represents the strategy used to display the ads. It can have the following values: Between Stories, Between Pages, Between Stories and Pages, Between Clips.

Ad Response Identifier

The adResponseIdentifier: String? represents the response identifier attached to the ad that was received from the ad provider. Used for debugging ad targeting.

Ad Index

The adIndex: Int? represents the order of the Ad within the displayed Ads in a Story or Clip collection (1 for the first Ad, 2 for the second, etc.). This field is included in all ad-related events.

Is Initial Buffering

The isInitialBuffering: Boolean? value is returned if the buffering happens at the start of playback for that page. This is only included for BufferingStarted and BufferingEnded events.

Time Since Buffering Began

The timeSinceBufferingBegan: TimeInterval? value is the duration the current buffering lasted for in milliseconds. This is only included for BufferingEnded events.

Categories

The categories: [String]? value is the list of categories assigned to the story for which the event occurred. This is only included on OpenedStory events.

Poll Answer

The pollAnswerId: String? is the ID of the answer the user selected when voting. This is only included on VotedPoll events.

Trivia Quiz ID

The triviaQuizId: String? is the ID of the trivia quiz that was completed or answered. This is only included on TriviaQuizQuestionAnswered and TriviaQuizCompleted events.

Trivia Quiz Title

The triviaQuizTitle: String? is the title of the trivia quiz that was completed or answered. This is only included on TriviaQuizQuestionAnswered and TriviaQuizCompleted events.

Trivia Quiz Score

The triviaQuizScore: Int? value is the score of the trivia quiz that was completed. This is only included on TriviaQuizCompleted events.

Trivia Quiz Question ID

The triviaQuizQuestionId: String? is the ID of the trivia quiz question which was answered. This is only included on TriviaQuizQuestionAnswered events.

Trivia Quiz Answer ID

The triviaQuizAnswerId: String? is the ID of the selected trivia quiz answer. This is only included on TriviaQuizQuestionAnswered events.

Clip ID

The clipId: String? is the ID of the clip for which the event occurred.

Clip Title

The clipTitle: String? is the title of the clip for which the event occurred.

Clip Index

The clipIndex: Int? is the index of the clip in the row or grid at the point it was selected or the index of the clip in the player inside the original row or grid. For Ad events, clip index refers to the index of the clip before the Ad.

Clip Collection Count

The clipCollectionCount: Int? is the total number of clips in the collection being viewed.

Clip Feed Type

The clipFeedType: String? indicates the type of clip feed being viewed. Possible values are default, forYou, and following.

Clips Viewed

The clipsViewed: Int? value is the total number of clips a user has viewed since the most recent OpenedClip event with an Opened Reason of clipListTap, pageActionButton, card, clipActionButton or deepLink. This count should be reset after any DismissedClip events.

Loops Viewed

The loopsViewed: Int? is for DismissedClip, the total number of loops (plays of an individual clip) a user has viewed since the most recent OpenedClip event with an Opened Reason of clipListTap, pageActionButton, card, clipActionButton or deepLink.

This count should be reset after any DismissedClip events. For FinishedClip, the total number of loops.

Is Live

The isLive: Bool? indicates whether a Clip, Story, or Card is currently being broadcast in real-time and is therefore "Live".

Airplay Enabled

The airplayEnabled: Bool? indicates whether the device is currently using AirPlay for audio/video output when the event occurred.

Clip Has Action

The clipHasAction: Bool? value is whether the clip associated with the event contains a primary action.

Clip Action Text

The clipActionText: String? is the text call to action if the clip associated with the event has a primary action link.

Clip Action URL

The clipActionUrl: String? is the URL linked to from the primary action if a clip associated with the event has a primary action.

Clip Action Type

The clipActionType: String? is the type of the primary action on a clip associated with the event. If there is no action button then the value is nil.

Collection

The collection is the ID of the collection if a story or clip is being played from a collection.

Collection Title

The collectionTitle: String? is the title of the collection if clip is being played from a collection.

Container Title

The containerTitle is the title of the collection if a story or clip is being played from a collection.

Category Details

The categoryDetails is a list of Category Detail objects. The details are the name, ID, type and placement of the category.

Category Name

The categoryName of the category being navigated to or dismissed.

Category ID

The categoryId of the category being navigated to or dismissed.

Current Category

The currentCategory is the category for the row that is currently being interacted with. The information provided from this is the category title, ID and placement.

This is only included on story and ad events.

Captions Enabled

The captionsEnabled property indicates whether captions are currently enabled for the Clips Player. This is included in all Clip Analytics Events and represents the state of captions at the time the event occurred.

Start Position

The startPosition: Int? represents the playback position, in milliseconds, when the user started scrubbing the clip. This is only included for ScrubbedClip events.

End Position

The endPosition: Int? represents the playback position, in milliseconds, when the user stopped scrubbing the clip. This is only included for ScrubbedClip events.

Eyebrow

The eyebrow: String? is a text field displayed on stories and clips, typically shown above the main title as a subtitle or descriptor.

Scrub Direction

The scrubDirection: String? indicates whether the user scrubbed to a position forward or backward on a Clip. Possible values are forward and backward. This is only included for ScrubbedClip events.

Completion Type

The completionType: String? indicates how a user finished watching a Clip. Possible values are natural and scrubbed. This is included for FinishedClip and ClipCompletedLoop events.

Sheet ID

The ID of the Sheet for which the event occurred.

Sheet Size

The height of the Sheet for which the event occurred. Possible values are 50, 75, and 100 (representing % of screen height).

Sheet Title

The title of the Sheet for which the event occurred.

Search From

The searchFrom indicates whether the Search for which the event is recorded was opened from Clips or Stories.

Is Suggestion

The isSuggestion indicates whether the Search for which the event is recorded used a suggested Search.

Note: When filters are opened (event), the Is Suggestion value should reflect what was used for the initial search performed before opening filters.

Initial Input

The initialInput this property tracks the input at the moment the suggestion was used.

Search Filter

The searchFilter property includes the content type and date posted used by search filter.

Search Sort

The searchSort field indicates method by which the relevant Story / Clip's search results were sorted.

Search Term

The searchTerm by which the Clips / Stories were searched, either entered in the search bar by the user or selected / filled from search suggestions.

Action Text

The actionText: String? property is used for general action text and can apply to both page actions and clip actions depending on the placement context.

Action Type

The actionType: String? property is used for general action types, and can apply to both page actions and clip actions depending on the placement context.

Action URL

The actionUrl: String? is the URL for the action link. This property is used for general action URLs in events and can apply to both page actions and clip actions depending on the placement context.

Action Class

The actionClass: String? identifies whether the action button that was tapped is a primary or secondary action. Possible values are primary and secondary. This is only included for ClipActionButtonTapped events.

Action Index

The actionIndex: Int? is the 1-based index of the secondary action that was tapped. This is only included for ClipActionButtonTapped events when a secondary action is tapped.

Tapped Clip Action Text

The tappedClipActionText: String? is the text of the specific action button (primary or secondary) that was tapped. This is only included for ClipActionButtonTapped events.

Tapped Clip Action URL

The tappedClipActionUrl: String? is the URL of the specific action button (primary or secondary) that was tapped. This is only included for ClipActionButtonTapped events.

Tapped Clip Action Type

The tappedClipActionType: String? is the type of the specific action button (primary or secondary) that was tapped. This is only included for ClipActionButtonTapped events.

Has Secondary Actions

The clipHasSecondaryActions: Bool? indicates whether the clip has any secondary actions. This is included in all Clip Analytics Events.

Secondary Actions Text

The clipSecondaryActionsText: [String]? is an array of all the text CTAs on secondary actions for the clip. This is included in all Clip Analytics Events when the clip has secondary actions.

Secondary Action URLs

The clipSecondaryActionUrls: [String]? is an array of all the URLs on secondary actions for the clip. This is included in all Clip Analytics Events when the clip has secondary actions.

Secondary Action Types

The clipSecondaryActionTypes: [String]? is an array of all the types of secondary actions for the clip. This is included in all Clip Analytics Events when the clip has secondary actions.

Card ID

The cardId: String? is the ID of the Card for which the event occurred. This is included for CardTapped event.

Card Action Type

The cardActionType: String? is the type of the action on the Card. This is included for CardTapped event.

Card Action URL

The cardActionUrl: String? is the URL for the link if the Card has an action. This is included for CardTapped event.

Card Aspect Ratio

The cardAspectRatio: String? is the aspect ratio of the Card. This is included for CardTapped event.

Card Background Type

The cardBackgroundType: String? is the type of background on the Card. This can have the value image or video. This is included for CardTapped event.

Card Collection ID

The cardCollectionId: String? is the ID of the collection the Card belongs to. This is included for CardTapped event.

Card Index

The cardIndex: Int? is the index of the Card in the collection.

Note: This value is 1-based.

Card Subtitle

The cardSubtitle: String? is the subtitle text displayed on the Card. This is included for CardTapped event.

Card Title

The cardTitle: String? is the title text displayed on the Card. This is included for CardTapped event.

Has Button

The hasButton: Bool? indicates whether the Card displayed a button. This is included for CardViewed and CardTapped events.

Has Action

The hasAction: Bool? indicates whether an ad contains an action. This property is used for general action presence in ad events and can apply to both page actions and clip actions depending on the ad placement context. This is only included for ad events.

Followable Category Limit Dialogue

The followableCategoryLimitDialogue: String? is the text displayed in the Followable Category Limit dialogue box. This is included for FollowableCategoryLimitShown, FollowableCategoryLimitActionButtonTapped, and FollowableCategoryLimitDismissed events.

Followable Category Limit Action Text

The followableCategoryLimitActionText: String? is the text displayed on the customisable action button in the Followable Category Limit dialogue box. This is included for FollowableCategoryLimitShown, FollowableCategoryLimitActionButtonTapped, and FollowableCategoryLimitDismissed events.

Followable Category Limit Action URL

The followableCategoryLimitActionUrl: String? is the URL associated with the customisable action button in the Followable Category Limit dialogue box. This is included for FollowableCategoryLimitShown, FollowableCategoryLimitActionButtonTapped, and FollowableCategoryLimitDismissed events.

Is Muted

The isMuted: Bool? indicates whether the audio is currently muted when the event occurred. This property is included in all Story, Clip, and Ad analytics events and represents the mute state at the time the event was tracked.

Metadata

The metadata: [String: String]? contains custom metadata associated with the content for which the event occurred. For Clip events, this contains the metadata from the associated clip. For Story events, this contains the metadata from the associated page. This property is included in all Story and Clip analytics events.

Context

The context: StorytellerContext? contains custom context data that was provided when configuring the SDK row/grid/card component. This allows integrators to track the context of where the analytics event occured. This property is included in all Story, Clip, Ad, Media Playback analytics events.