Story Events#
Opened Story (openedStory)#
The openedStory event is recorded when:
- A user taps on a row item to open a Story
- A Story is loaded because the previous Story finished
- A Story is loaded because the user skipped the last Page of the previous Story
- A user swipes left to the next Story
- A user swipes right to the previous Story
- A user is sent directly to a Story via a deeplink
The event contains the following event properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| 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. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Opened Reason | openedReason |
The action which the user took to open the Story | OpenedReason |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1, 2, 3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Dismissed Story (dismissedStory)#
The dismissedStory event is recorded when:
- A user taps close to dismiss the Story
- 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
- A user swipes left on the final Story to dismiss the Story
- A user swipes right on the first Story to dismiss the Story
- A user completes the final Page of the final Story and the Story view is dismissed
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Dismissed Reason | dismissedReason |
The reason the Story was dismissed. | DismissedReason |
| Duration Viewed | durationViewed |
In milliseconds, the duration over which the user viewed the Story (measured from the most recent Opened Story event with an openedReason of storyListTap or deepLink). This timer should be reset after any Dismissed Story events. |
1200, 1312, 29 |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| Page Viewed Count | pagesViewedCount |
The total number of Pages a user has viewed since the most recent Opened Story event with an openedReason of storyListTap or deepLink. This count should be reset after any Dismissed Story events. |
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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Skipped Story (skippedStory)#
The skippedStory event is recorded when:
- A user swipes left to the next Story before completing the current Story
- A user skips the last Page of a Story
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Completed Story (completedStory)#
The completedStory event is recorded when the final Page in a Story is opened. Note that the Opened Page event will be recorded at the same time.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| 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. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', type: 'game', placement: { title: 'Game Screen', code: 'game-screen' } }] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Opened Page (openedPage)#
The openedPage event is recorded when user first opens a Page.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Content Length | contentLength |
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 title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Opened Reason | openedReason |
The action which the user took to open the Story | OpenedReason |
| 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://www.youtube.com/watch?v=oHg5SJYRHA0" |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1, 2, 3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Action Button Tapped (actionButtonTapped)#
The actionButtonTapped event is recorded when:
- A user swipes up on a Page to open a link
- A user taps on the swipe up element of a Page to open a link
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| 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://www.youtube.com/watch?v=oHg5SJYRHA0" |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Share Button Tapped (shareButtonTapped)#
The shareButtonTapped event is recorded when a user taps the share button on a Page.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Index | pageIndex |
The index of the Page in the Story for which the event occurred. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Previous Page (previousPage)#
The previousPage event is recorded when a user taps back to go to a previous Page in the Story.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |
Previous Story (previousStory)#
The previousStory event is recorded when:
- A user swipes right to go to the previous Story (unless this is the first Story - in which case Dismissed Story is fired instead)
- A user taps back on the first Page in a Story (and this is not the first Page in the first Story)
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| 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. Note that this property should not be influenced by the presence (or absence) of any Ads and uses 1-based indexing. | 1,2,3... |
| Page Type | pageType |
The type of Page associated with the event. | image, video, ad |
| 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. Note that 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 |
Used to determine if the Story was opened using Storyteller.open* methods or by the user tapping on the Row. | 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 display title of the Story for which the event occurred. | “Tonight’s Movies”, “Quote of the Day” |