Analytics#

Event Types
Story Events
Clip Events
Search Events
Opened Search
Dismissed Search
Performed Search
Opened Filters
Dismissed Filters
Used Suggestion
Ad Events
Playback Events
Navigation Events
Event Tracking Configuration
Event Data

Event Types#

These are the various events which are triggered from within the SDK. Each event is a member of the UserActivity.EventType enumeration.

React Native: Subscribe to events using StorytellerSdk.onUserActivityOccurred(). iOS/Android Native: See the StorytellerDelegate page for delegate pattern details.

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#

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, event data for storyID, storyTitle, storyIndex, storyPageCount, storyReadStatus, storyPlaybackMode, openedReason, currentCategory and categories is returned.

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, event data for pageID, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl contentLength, storyID, storyTitle, storyIndex, storyPageCount, currentCategory and openedReason is returned.

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, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, pageType dismissedReason, durationViewed, currentCategory and pagesViewedCount is returned.

Skipped Story#

This event is recorded when:

a user swipes left to go to the next story
a user skips the last page of a story to go to the next story

Whenever a Skipped Story event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, currentCategory and pageType is returned.

Skipped Page#

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

Whenever a Skipped Page event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, currentCategory and pageType is returned.

Completed Story#

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

Whenever a Completed Story event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, currentCategory and pageType is returned.

Completed Page#

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

Whenever a Completed Page event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, pageType, currentCategory and contentLength is returned.

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, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, pageType, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

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

Whenever a Share Button Tapped event occurs, event data for shareMethod, storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, currentCategory and pageType is returned.

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)

Whenever a Previous Story event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, currentCategory and pageType is returned.

Previous Page#

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

Whenever a Previous Page event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, currentCategory and pageType is returned.

This event is recorded when a user:

selects a sharing method from the system dialog.

Whenever a Share Success event occurs, event data for storyId, storyTitle, storyIndex, storyPageCount storyPlaybackMode, pageID, pageIndex, pageType, currentCategory and shareMethod is returned.

Voted Poll#

This event is recorded when user votes in a poll.

Whenever a Voted Poll event occurs, event data for storyId, storyTitle, storyIndex, pageId, pageIndex, pageType, currentCategory and pollAnswerId is returned.

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, event data for storyId, storyTitle, storyIndex, storyPlaybackMode, pageID, pageIndex, pageType, triviaQuizId, triviaQuizTitle, triviaQuizQuestionId, currentCategory and triviaQuizAnswerId is returned.

Trivia Quiz Completed#

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

Whenever a Trivia Quiz Completed event occurs, event data for storyId, storyTitle, storyIndex, storyPlaybackMode, pageID, pageIndex, pageType, triviaQuizId, triviaQuizTitle, triviaQuizScore and currentCategory is returned.

Clip Events#

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 a Opened Clip event occurs, event data for clipId, clipTitle, clipIndex, clipHasAction, openedReason, collection, categories, contentLength, clipFeedType (values: default, forYou, following) and categoryDetails is returned.

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, event data for clipId, clipTitle, clipIndex, dismissedReason, durationViewed, clipsViewed, collection, categories, clipFeedType and loopsViewed is returned.

Next Clip#

This event is recorded when:

a user swipes up to go to the next clip

Whenever a Next Clip event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

Previous Clip#

This event is recorded when:

a user swipes down to go to the previous clip

Whenever a Previous Clip event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

Completed Loop#

This event is recorded when:

a user completes a loop of a clip

Whenever a Completed Loop event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

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

Action Button Tapped#

This event is recorded when:

a user taps the action button at the bottom of a clip
a user swipes left on a clip to open the relevant action

Whenever an Action Button Tapped event occurs, event data for clipId, clipTitle, clipIndex, clipHasAction, clipActionText, collection, categories, clipFeedType and clipActionUrl is returned.

This event is recorded when:

a user taps the share button on a clip

Whenever a Share Button Tapped event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

This event is recorded when:

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

Whenever a Share Success event occurs, event data for clipId, clipTitle, clipIndex, collection, categories, clipFeedType and shareMethod is returned.

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

Whenever a Paused Clip event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

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

Whenever a Resumed Clip event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

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

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

Whenever a Liked Clip event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

Unliked Clip#

This event is recorded when:

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

Whenever a Unliked Clip event occurs, event data for clipId, clipTitle, collection, categories, clipFeedType and clipIndex is returned.

Finished Clip#

This event is recorded when:

Dismissed Clip is fired
Next Clip is fired
Previous Clip is fired
At the same time as OpenedCategory
A user is viewing a Collection with “For You/Following” enabled and switches between "For You" and "Following".

Whenever a Finished Clip event occurs, event data for clipId, clipTitle, clipIndex, loopsViewed, durationViewed, collection, categories, clipFeedType and contentLength is returned.

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

This event is not fired when opening the top level of a collection - only when navigating to a specific category. Whenever a Opened Category event occurs, event data for clipId, clipTitle, clipIndex, collection, categories, categoryId, clipFeedType and categoryName is returned.

Dismissed Category#

This event is recorded when:

a user navigates back using the back button (or system back on Android) to the previous category.

This event does not fire when dismissing the top level collection.

Whenever a Dismissed Category event occurs, event data for clipId, clipTitle, clipIndex, collection, categories, categoryId, clipFeedType and categoryName is returned.

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

Whenever a Follow Category event occurs, event data for clipId, clipTitle, clipIndex, collection, categories, categoryId, clipFeedType and categoryName is returned.

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

Whenever a Unfollow Category event occurs, event data for clipId, clipTitle, clipIndex, collection, categories, categoryId, clipFeedType and categoryName is returned.

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

Whenever a Followable Category Tapped event occurs, event data for clipId, clipTitle, clipIndex, collection, categories, categoryId, clipFeedType and categoryName is returned.

Search Events#

Opened Search#

This event is recorded when:

a user open Search screen

Whenever an Opened Search event occurs, event data for storyId, storyTitle, storyDisplayTitle, storyIndex, storyPageCount, storyReadStatus, pageId, pageTitle, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl, categories, categoryDetails, collection, currentCategory, clipId, clipTitle, clipIndex, clipActionText and searchFrom is returned.

Dismissed Search#

This event is recorded when:

a user exits the Search screen

Whenever a Dismissed Search event occurs, event data for storyId, storyTitle, storyDisplayTitle, storyIndex, storyPageCount, storyReadStatus, pageId, pageTitle, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl, dismissedReason, categories, categoryDetails, collection, currentCategory, clipId, clipTitle, clipIndex, clipActionText and searchFrom is returned.

Performed Search#

This event is recorded when:

a user clicks on the Search button after entering the search term

Whenever a Performed Search event occurs, event data for storyId, storyTitle, storyDisplayTitle, storyIndex, storyPageCount, storyReadStatus, pageId, pageTitle, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl, categories, categoryDetails, collection, currentCategory, clipId, clipTitle, clipIndex, clipActionText, searchFilter, searchSort, searchTerm, searchFrom, isSuggestion, and initialInput is returned.

Opened Filters#

This event is recorded when:

a user taps the filter button to open the sheet containing filter options

Whenever an Opened Filters event occurs, event data for storyId, storyTitle, storyDisplayTitle, storyIndex, storyPageCount, storyReadStatus, pageId, pageTitle, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl, categories, categoryDetails, collection, currentCategory, clipId, clipTitle, clipIndex, clipActionText, searchFilter, searchSort, searchTerm, searchFrom, isSuggestion, and initialInput is returned.

Dismissed Filters#

This event is recorded when:

a user closes the sheet containing filter options

Whenever a Dismissed Filters event occurs, event data for storyId, storyTitle, storyDisplayTitle, storyIndex, storyPageCount, storyReadStatus, pageId, pageTitle, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl, categories, categoryDetails, collection, currentCategory, clipId, clipTitle, clipIndex, clipActionText, searchFilter, searchSort, searchTerm, searchFrom, isSuggestion, and initialInput is returned.

Used Suggestion#

This event is recorded when:

a user taps on a search suggestion

Whenever a Used Suggestion event occurs, event data for storyId, storyTitle, storyDisplayTitle, storyIndex, storyPageCount, storyReadStatus, pageId, pageTitle, pageIndex, pageType, storyPlaybackMode, pageHasAction, pageActionText, pageActionUrl, categories, categoryDetails, collection, currentCategory, clipId, clipTitle, clipIndex, clipActionText, searchTerm, searchFrom, isSuggestion, and initialInput is returned.

Ad Events#

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 a Opened Ad event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, openedReason, adView, contentLength, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

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, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, openedReason, adView, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, dismissedReason, durationViewed, pagesViewed, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

Clips#

This event is recorded when a user:

taps the back button to exit the clips player when an ad is being shown
(Android only) presses the system back button to exit the clips player when an ad is being shown

Whenever a Dismissed Ad event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, dismissedReason, durationViewed, pagesViewed, clipsViewed, loopsViewed, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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

Whenever a Skipped Ad event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

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

Whenever a Skipped Ad event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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

Whenever a Ad Action Button Tapped event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

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

Whenever a Ad Action Button Tapped event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, adView, contentLength, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

Clips#

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

Whenever a Finished Ad event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, adView, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

Paused Ad#

Stories#

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

Whenever a Paused Ad Page event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

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

Whenever a Paused Ad Clip event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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.

Whenever a Resumed Ad Page event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, pageActionText, currentCategory and pageActionUrl is returned.

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

Whenever a Resumed Ad Clip event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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.

Whenever a Viewed Ad Page First Quartile event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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.

Whenever a Viewed Ad Page Midpoint event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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.

Whenever a Viewed Ad Page Third Quartile event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

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.

Whenever a Viewed Ad Page Complete event occurs, event data for advertiserName, adId, adType, adPlacement, adFormat, adResponseIdentifier, pageType, contentLength, pageHasAction, clipHasAction, pageActionText, clipActionText, pageActionUrl, clipActionUrl, currentCategory, collection is returned.

Playback Events#

Ready to Play#

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

Whenever a Ready to Play event occurs, event data for storyId, storyTitle, storyIndex, pageID, pageIndexand pageType is returned.

Media Started#

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

Whenever a Media Started event occurs, event data for storyId, storyTitle, storyIndex, pageID, pageIndexand pageType is returned.

Buffering Started#

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

Whenever a Buffering Started event occurs, event data for storyId, storyTitle, storyIndex, pageID, pageIndex, pageType and isInitialBuffering is returned.

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, event data for storyId, storyTitle, storyIndex, pageID, pageIndex, pageType, isInitialBuffering and timeSinceBufferingBegan is returned.

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:

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?: number 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?: number 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?: number 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?: boolean value states whether the page associated with the event contains an action.

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.

Page Action Type#

The pageActionType?: string defines the type of action associated with a page, possible values are: inApp, web, store, externalApp, share or none.

Opened Reason#

The openedReason?: string value states how the user opened a story or clip. The possible values for this are storyRowTap (the user tapped the story in the story row); 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); tap (the user tapped on the previous page to navigate to this page) and clipListTap (the user tapped the clip in a clip list).

openedReason is only included on OpenedStory and OpenedClip 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 durationViewedMs?: number 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 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?: number is 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.

Content Length#

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

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

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?: number value is the duration the current buffering lasted for in milliseconds. This is only included for BufferingEnded events.

Categories#

The categories?: Array<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?: number 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?: number 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 feed at the point it was viewed.

Clips Viewed#

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

Loops Viewed#

The loopsViewed?: number 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 or deepLink.

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

Clip Has Action#

The clipHasAction?: boolean value is whether the clip associated with the event contains an action.

Clip Action Text#

The clipActionText?: string is the text call to action if the clip associated with the event has an action link.

Clip Action URL#

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

Clip Action Type#

The clipActionType?: string defines the type of action associated with a clip, possible values are: inApp, web, store, externalApp, share or none.

Clip Feed Type#

The clipFeedType?: string? indicates the type of feed the clip is in, possible values are: default, forYou, following.

Is Live#

The isLive?: boolean indicates if the Clip is live.

Category Type#

The categoryType?: string specifies the type of the Clip category.

Collection#

The collection?: string is the ID of the collection if a Story or Clip is being played from a collection.

Collection Clip Count#

The collectionClipCount?: number represents the number of Clips in a collection.

Location#

The location?: string represents the location of a Clip, possible values are: On Clip and Category Screen.

Category Details#

The categoryDetails?: Array<CategoryDetail> is a list of Category Detail objects. The details are the name, ID, type and placement of the category.

Category Name#

The categoryName?: string of the category being navigated to or dismissed.

Category ID#

The categoryId?: string of the category being navigated to or dismissed.

Current Category#

The currentCategory?: CurrentCategoryData 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.

Locale#

The locale?: string indicates the locale setting when the event occurred.

Item Title#

The itemTitle?: string represents the title of the item involved in the event, for Stories that's a page title, for Clips it's a Clip title.

Action Text#

The actionText?: string represents the text on the action button of the item involved in the event.

Container Title#

The containerTitle?: string represents the title of the container that current item is in, for Stories that's a Story title, for Clips it's a collection name.

Metadata#

The metadata?: Map<String, String> contains additional metadata associated with the event.

Analytics#

Event Types#

Story Events#

Opened Story#

Opened Page#

Dismissed Story#

Skipped Story#

Skipped Page#

Completed Story#

Completed Page#

Action Button Tapped#

Share Button Tapped#

Previous Story#

Previous Page#

Share Success#

Voted Poll#

Trivia Quiz Question Answered#

Trivia Quiz Completed#

Clip Events#

Opened Clip#

Dismissed Clip#

Next Clip#

Previous Clip#

Completed Loop#

Action Button Tapped#

Share Button Tapped#

Share Success#

Paused Clip#

Resumed Clip#

Liked Clip#

Unliked Clip#

Finished Clip#

Opened Category#

Dismissed Category#

Follow Category#

Unfollow Category#

Followable Category Tapped#

Search Events#

Opened Search#

Dismissed Search#

Performed Search#

Opened Filters#

Dismissed Filters#

Used Suggestion#

Ad Events#

Opened Ad#

Stories#

Clips#

Dismissed Ad#

Stories#

Clips#

Skipped Ad#

Stories#

Clips#

Ad Action Button Tapped#

Stories#

Clips#

Finished Ad#

Stories#

Clips#

Paused Ad#

Stories#

Clips#

Resumed Ad#

Stories#

Clips#

Viewed Ad Page First Quartile#

Viewed Ad Page Midpoint#

Viewed Ad Page Third Quartile#

Viewed Ad Page Complete#

Playback Events#

Ready to Play#

Media Started#

Buffering Started#

Buffering Ended#

Event Data#

Story ID#

Story Title#

Story Display Title#

Story Index#