Quiz Events#
This page lists the Quiz 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.
Trivia Quiz Question Answered (triviaQuizQuestionAnswered)#
The triviaQuizQuestionAnswered event is recorded when:
- A user answers a question in a Trivia Quiz
- A user times out on a question
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. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }] |
| 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' } |
| 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 |
| 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. | “Game Day: 532CE Greens v Blues” |
| Trivia Quiz Answer ID | triviaQuizAnswerId |
The ID of the Trivia Quiz Answer the user selects. If the user times out or exits the Story view, this should be an empty GUID. | be772f10-177e-4754-ac09-f91cb547316f |
| Trivia Quiz ID | triviaQuizId |
The ID of the Trivia Quiz with which the user is interacting. | be772f10-177e-4754-ac09-f91cb547316f |
| Trivia Quiz Question ID | triviaQuizQuestionId |
The ID of the Trivia Quiz question with which the user is interacting. | 9c1d7e62-4a5b-4f0e-8d3a-2b6f1c0e7a94 |
| Trivia Quiz Title | triviaQuizTitle |
The Title of the Trivia Quiz with which the user is interacting. | “Who is the greatest quarterback of all time?” |
Trivia Quiz Completed (triviaQuizCompleted)#
The triviaQuizCompleted event is recorded when a user completes a Trivia Quiz. It therefore fires at the same time as the final triviaQuizQuestionAnswered event for that Quiz, and is only fired once per user per Quiz.
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. | [{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }] |
| 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' } |
| 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 |
| 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. | “Game Day: 532CE Greens v Blues” |
| Trivia Quiz ID | triviaQuizId |
The ID of the Trivia Quiz with which the user is interacting. | be772f10-177e-4754-ac09-f91cb547316f |
| Trivia Quiz Score | triviaQuizScore |
The score of the Trivia Quiz, once completed. | 2, 5, 9 |
| Trivia Quiz Title | triviaQuizTitle |
The Title of the Trivia Quiz with which the user is interacting. | “Who is the greatest quarterback of all time?” |