This page lists the Story events that the SDK sends to onUserActivityOccurred,
when each one is recorded, and its properties. The Storyteller Web Showcase
handles these events in its onUserActivityOccurred handler.
Story and Page activity callbacks that identify a Story or Page include a
captionsEnabled boolean. The value records the caption choice when the event
occurs. Stories and Clips share that choice. The SDK saves it in the browser
when functional storage is allowed. With functional storage disabled, the
choice lasts until the page reloads.
The player emits enabledStoryCaptions for an enabled choice or
disabledStoryCaptions for a disabled choice. Each toggle event
includes the resulting captionsEnabled value, plus the active Story and Page
identifiers, titles, one-based indexes, category information, and Page action
fields.
Event property
Value in a Story caption toggle event
captionsEnabled
true or false for the resulting choice.
categories
Names of the categories assigned to the Story.
categoryDetails
A list of objects with name, id, type, and optional externalId and string placement.
currentCategory
An object with title, optional id, and optional string placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Read Status
storyReadStatus
Whether the Story was read or unread at the point it was opened.
read, unread
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
In milliseconds, how long the user viewed Stories, measured from the most recent openedStory event with an openedReason of storyListTap or deepLink. The timer resets after each dismissedStory event.
1200, 1312, 29
Page Action Text
pageActionText
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Pages Viewed
pagesViewed
The total number of Pages the user has viewed since the most recent openedStory event with an openedReason of storyListTap or deepLink. The count resets after each dismissedStory event.
1, 2, 3, 4
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
In seconds, the total duration of the Page content.
15, 41, 32
Current Category
currentCategory
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The shareSuccess event is recorded when a user finishes sharing a Page. This
happens when the promise returned by your onShareButtonTapped callback
resolves, when the browser share sheet completes, or when the Page media
finishes downloading.
This event contains the following properties:
Event Property
Property Name
Description
Sample values
Captions Enabled
captionsEnabled
Whether captions were on when the event occurred.
true, false
Categories
categories
A list of the category names assigned to the Story for which the event occurred.
["Top Stories", "Europe", "Recap"]
Category Details
categoryDetails
A list of Category Detail objects assigned to the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Share Method
shareMethod
How the Page was shared: as a link (shareLink) or as its media (shareMedia or share).
shareLink, shareMedia, share
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The completedPage event is recorded when a Page finishes and the player moves
on to the next Page or Story automatically. The event describes the Page that
finished.
ActivityType lists this event as deprecated, but the SDK still sends it. Avoid building new reports on it.
This event contains the following properties:
Event Property
Property Name
Description
Sample values
Captions Enabled
captionsEnabled
Whether captions were on when the event occurred.
true, false
Categories
categories
A list of the category names assigned to the Story for which the event occurred.
["Top Stories", "Europe", "Recap"]
Category Details
categoryDetails
A list of Category Detail objects assigned to the Story for which the event occurred.
In seconds, the total duration of the Page content.
15, 41, 32
Current Category
currentCategory
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
If the Page associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Swipe Up”, “Get Started”
Page Action URL
pageActionUrl
If the Page associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Page Has Action
pageHasAction
Whether the Page associated with the event contains an Action.
true, false
Page ID
pageId
The ID of the Page for which the event occurred.
cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658
Page Index
pageIndex
The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing.
1, 2, 3, …
Page Title
pageTitle
The title of the Page for which the event occurred.
“Stats page”, “Best Fit”
Page Type
pageType
The type of Page associated with the event.
image, video, poll, triviaQuiz
Story ID
storyId
The ID of the Story for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Story Index
storyIndex
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 property uses 1-based indexing.
1, 2, 3, …
Story Page Count
storyPageCount
The number of Pages in the Story.
1, 2, 3, …
Story Playback Mode
storyPlaybackMode
Whether the Story was opened with a Storyteller.sharedInstance.open* method or its URL (singleStory), or by the user tapping it in a row or grid (list).
list, singleStory
Story Title
storyTitle
The title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
Story Display Title
storyDisplayTitle
The long display title of the Story for which the event occurred.
“Tonight’s Movies”, “Quote of the Day”
{"slug": "analytics-story-events", "page_title": "Story Events", "page_url": "analytics/StoryEvents/", "canonical_url": "/web/analytics/StoryEvents/", "markdown": "# Story Events\n\nThis page lists the Story events that the SDK sends to `onUserActivityOccurred`,\nwhen each one is recorded, and its properties. The Storyteller Web Showcase\nhandles these events in its [`onUserActivityOccurred` handler](https://github.com/getstoryteller/storyteller-showcase-web/blob/11.0.0/nextjs/src/components/contexts/storytellerSdkDelegate.ts#L60).\n\n## Caption state and events\n\nStory and Page activity callbacks that identify a Story or Page include a\n`captionsEnabled` boolean. The value records the caption choice when the event\noccurs. Stories and Clips share that choice. The SDK saves it in the browser\nwhen functional storage is allowed. With functional storage disabled, the\nchoice lasts until the page reloads.\n\nThe player emits `enabledStoryCaptions` for an enabled choice or\n`disabledStoryCaptions` for a disabled choice. Each toggle event\nincludes the resulting `captionsEnabled` value, plus the active Story and Page\nidentifiers, titles, one-based indexes, category information, and Page action\nfields.\n\n| Event property | Value in a Story caption toggle event |\n| --- | --- |\n| `captionsEnabled` | `true` or `false` for the resulting choice. |\n| `categories` | Names of the categories assigned to the Story. |\n| `categoryDetails` | A list of objects with `name`, `id`, `type`, and optional `externalId` and string `placement`. |\n| `currentCategory` | An object with `title`, optional `id`, and optional string `placement`. |\n| `storyId`, `storyTitle`, `storyDisplayTitle`, `storyIndex`, `storyPageCount` | The active Story and its one-based index. |\n| `pageId`, `pageTitle`, `pageType`, `pageIndex` | The active Page and its one-based index. |\n| `pageHasAction`, `pageActionText`, `pageActionUrl` | Action details for the active Page. |\n\n## Opened Story (`openedStory`)\n\nThe `openedStory` event is recorded when:\n\n- A user taps on a row item to open a Story\n- A Story is loaded because the previous Story finished\n- A Story is loaded because the user skipped the last Page of the previous Story\n- A user swipes left to the next Story\n- A user swipes right to the previous Story\n- A user is sent directly to a Story by a deep link\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Opened Reason | `openedReason` | The action which the user took to open the Story. | [OpenedReason](../Analytics.md#openedreason) |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Read Status | `storyReadStatus` | Whether the Story was read or unread at the point it was opened. | `read`, `unread` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Dismissed Story (`dismissedStory`)\n\nThe `dismissedStory` event is recorded when:\n\n- A user taps close to dismiss the Story\n- A user taps to skip the last Page of the final Story to dismiss the Story and go back to the page they were on previously\n- A user swipes left on the final Story to dismiss the Story\n- A user swipes right on the first Story to dismiss the Story\n- A user completes the final Page of the final Story and the Story view is dismissed\n- The player closes for another [DismissedReason](../Analytics.md#dismissedreason), such as the browser back button or the `Esc` key\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Dismissed Reason | `dismissedReason` | The reason the Story was dismissed. | [DismissedReason](../Analytics.md#dismissedreason) |\n| Duration Viewed | `durationViewed` | In milliseconds, how long the user viewed Stories, measured from the most recent `openedStory` event with an `openedReason` of `storyListTap` or `deepLink`. The timer resets after each `dismissedStory` event. | 1200, 1312, 29 |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Pages Viewed | `pagesViewed` | The total number of Pages the user has viewed since the most recent `openedStory` event with an `openedReason` of `storyListTap` or `deepLink`. The count resets after each `dismissedStory` event. | 1, 2, 3, 4 |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Skipped Story (`skippedStory`)\n\nThe `skippedStory` event is recorded when:\n\n- A user swipes left to the next Story before completing the current Story\n- A user skips the last Page of a Story\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Completed Story (`completedStory`)\n\nThe `completedStory` event is recorded when the final Page in a Story is opened. The `openedPage` event is recorded at the same time.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Opened Page (`openedPage`)\n\nThe `openedPage` event is recorded when a user first opens a Page.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Content Length | `contentLength` | In seconds, the total duration of the Page content. | 15, 41, 32 |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Opened Reason | `openedReason` | The action which the user took to open the Page. | [OpenedReason](../Analytics.md#openedreason) |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Action Button Tapped (`actionButtonTapped`)\n\nThe `actionButtonTapped` event is recorded when:\n\n- A user swipes up on a Page to open a link\n- A user taps on the swipe up element of a Page to open a link\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Share Button Tapped (`shareButtonTapped`)\n\nThe `shareButtonTapped` event is recorded when a user taps the share button on a Page.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Share Success (`shareSuccess`)\n\nThe `shareSuccess` event is recorded when a user finishes sharing a Page. This\nhappens when the promise returned by your `onShareButtonTapped` callback\nresolves, when the browser share sheet completes, or when the Page media\nfinishes downloading.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Share Method | `shareMethod` | How the Page was shared: as a link (`shareLink`) or as its media (`shareMedia` or `share`). | `shareLink`, `shareMedia`, `share` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Previous Page (`previousPage`)\n\nThe `previousPage` event is recorded when a user taps back to go to a previous Page in the Story.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Previous Story (`previousStory`)\n\nThe `previousStory` event is recorded when:\n\n- A user swipes right to go to the previous Story (unless this is the first Story, in which case `dismissedStory` is recorded instead)\n- A user taps back on the first Page in a Story (and this is not the first Page in the first Story)\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Completed Page (`completedPage`)\n\nThe `completedPage` event is recorded when a Page finishes and the player moves\non to the next Page or Story automatically. The event describes the Page that\nfinished.\n\n`ActivityType` lists this event as deprecated, but the SDK still sends it. Avoid building new reports on it.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Content Length | `contentLength` | In seconds, the total duration of the Page content. | 15, 41, 32 |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n\n## Skipped Page (`skippedPage`)\n\nThe `skippedPage` event is recorded when a user taps or swipes forward to leave\na Page before it finishes. The event describes the Page the user left.\n\n`ActivityType` lists this event as deprecated, but the SDK still sends it. Avoid building new reports on it.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions were on when the event occurred. | `true`, `false` |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Action Text | `pageActionText` | If the Page associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the Page associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page ID | `pageId` | The ID of the Page for which the event occurred. | `cce4f2c3-c6f2-4a0a-9d8c-b52e4080e658` |\n| Page Index | `pageIndex` | The index of the Page in the Story for which the event occurred. Ads do not affect this index. This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Page Title | `pageTitle` | The title of the Page for which the event occurred. | \u201cStats page\u201d, \u201cBest Fit\u201d |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video`, `poll`, `triviaQuiz` |\n| Story ID | `storyId` | The ID of the Story for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Story Index | `storyIndex` | 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 property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Story Page Count | `storyPageCount` | The number of Pages in the Story. | 1, 2, 3, \u2026 |\n| Story Playback Mode | `storyPlaybackMode` | Whether the Story was opened with a `Storyteller.sharedInstance.open*` method or its URL (`singleStory`), or by the user tapping it in a row or grid (`list`). | `list`, `singleStory` |\n| Story Title | `storyTitle` | The title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n| Story Display Title | `storyDisplayTitle` | The long display title of the Story for which the event occurred. | \u201cTonight\u2019s Movies\u201d, \u201cQuote of the Day\u201d |\n", "copy_markdown_include_header": false, "base_path": "", "ai_dir": "ai", "missing_payload_behavior": "empty"}