This page lists the Clip 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.
In openedClip, dismissedClip, and finishedClip, categories holds the
names of the Clip's categories. In the other Clip events, it holds the
categories' external IDs. Use categoryDetails when you need both.
Clip activity callbacks include a captionsEnabled boolean with the caption
choice at the time of the event. 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 also records an event when the user changes that choice:
enabledClipCaptions when the user turns captions on
disabledClipCaptions when the user turns captions off
Both events contain the following properties:
Event Property
Property Name
Description
Sample values
Captions Enabled
captionsEnabled
Whether captions are enabled after the interaction.
true, false
Categories
categories
A list of the external IDs of the categories assigned to the Clip.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Content Length
contentLength
In seconds, the total duration of the Clip.
15, 21, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The dismissedClip event is recorded when a user taps on the back button in the top left to exit the Clips player (and is at the top of the stack of Clip Categories).
The 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 Clip for which the event occurred.
["Top Stories", "Europe", "Recap"]
Category Details
categoryDetails
A list of Category Detail objects assigned to the Clip.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The total number of Clips a user has viewed since the most recent openedClip event with an openedReason of clipListTap or deepLink.
1, 2, 3, …
Duration Viewed
durationViewed
In milliseconds, the duration the user viewed the Clips player for, measured from the most recent openedClip event with an openedReason of clipListTap or deepLink.
1200, …
Loops Viewed
loopsViewed
The total number of loops (plays of an individual Clip) a user has viewed since the most recent openedClip event with an openedReason of clipListTap or deepLink.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Content Length
contentLength
In seconds, the total duration of the Clip.
15, 21, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
https://example.com/action
Duration Viewed
durationViewed
In milliseconds, the duration the user viewed the Clips player for, measured from the most recent openedClip event with an openedReason of swipe.
1200, …
Loops Viewed
loopsViewed
The total number of loops (plays of an individual Clip) a user has viewed since the most recent openedClip event with an openedReason of swipe.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The pausedClip event is recorded when a user taps on the screen while a Clip is playing to pause the Clip. It is not recorded when a Clip pauses automatically because the user shares it or follows an action. It is never recorded for live Clips, because live Clips cannot be paused or resumed.
The 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 external IDs of the categories assigned to the Clip for which the event occurred.
["game-0012200025", "recap"]
Category Details
categoryDetails
A list of Category Detail objects assigned to the Clip.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The resumedClip event is recorded when a user taps a paused Clip to resume playback. It is not recorded when a Clip resumes automatically, for example after the user finishes sharing it. It is never recorded for live Clips, because live Clips cannot be paused or resumed.
The 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 external IDs of the categories assigned to the Clip for which the event occurred.
["game-0012200025", "recap"]
Category Details
categoryDetails
A list of Category Detail objects assigned to the Clip.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
The dismissedCategory event is recorded when a user navigates back to the previous Category with the back button. It is not recorded when the user dismisses the top level Collection.
The 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 external IDs of the categories assigned to the Clip for which the event occurred.
["game-0012200025", "recap"]
Category Details
categoryDetails
A list with the Category Detail object of the Category being dismissed.
The ID of the Collection, if the Clip is being played from one.
live-stories, top-stories, …
Clip ID
clipId
The ID of the Clip for which the event occurred.
3241dbc1-ae7b-4b55-a236-1294f18e2584
Clip Index
clipIndex
The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn’t opened from a row or grid). This property uses 1-based indexing.
1, 2, 3, …
Clip Title
clipTitle
The title of the Clip for which the event occurred.
"Highlights", "Tonight's Movies"
Clip Has Action
clipHasAction
Whether the Clip associated with the event contains an Action.
true, false
Clip Action Text
clipActionText
If the Clip associated with the event has an Action, this property captures its associated ‘Call To Action’ text.
“Watch Now”, …
Clip Action URL
clipActionUrl
If the Clip associated with the event has an Action, the URL to which the Action links.
https://example.com/action
{"slug": "analytics-clip-events", "page_title": "Clip Events", "page_url": "analytics/ClipEvents/", "canonical_url": "/web/analytics/ClipEvents/", "markdown": "# Clip Events\n\nThis page lists the Clip 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\nIn `openedClip`, `dismissedClip`, and `finishedClip`, `categories` holds the\nnames of the Clip's categories. In the other Clip events, it holds the\ncategories' external IDs. Use `categoryDetails` when you need both.\n\n## Caption state and events\n\nClip activity callbacks include a `captionsEnabled` boolean with the caption\nchoice at the time of the event. Stories and Clips share that choice. The SDK\nsaves it in the browser when functional storage is allowed. With functional\nstorage disabled, the choice lasts until the page reloads.\n\nThe player also records an event when the user changes that choice:\n\n- `enabledClipCaptions` when the user turns captions on\n- `disabledClipCaptions` when the user turns captions off\n\nBoth events contain the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Captions Enabled | `captionsEnabled` | Whether captions are enabled after the interaction. | `true`, `false` |\n| Categories | `categories` | A list of the external IDs of the categories assigned to the Clip. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The Clip's one-based index in the active feed. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | The Clip's Call To Action text, when present. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | The URL associated with the Clip's Action, when present. | `https://example.com/action` |\n\n## Opened Clip (`openedClip`)\n\nThe `openedClip` event is recorded when:\n\n- A user taps on a row or grid item to open a Clip\n- A user swipes up to the next Clip\n- A user swipes down to the previous Clip\n- A user is sent directly to a Clip by a call to `openCollection`\n- A user is sent directly to a Clip by a deep link\n- A user dismisses the last Category (by pressing back) and returns to the top level Collection\n\nThe 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 Clip for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Content Length | `contentLength` | In seconds, the total duration of the Clip. | `15`, `21`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Opened Reason | `openedReason` | The action which the user took to open the Clip. | [OpenedReason](../Analytics.md#openedreason) |\n\n## Dismissed Clip (`dismissedClip`)\n\nThe `dismissedClip` event is recorded when a user taps on the back button in the top left to exit the Clips player (and is at the top of the stack of Clip Categories).\n\nThe 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 Clip for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Dismissed Reason | `dismissedReason` | The reason the Clip was dismissed. | [DismissedReason](../Analytics.md#dismissedreason) |\n| Clips Viewed | `clipsViewed` | The total number of Clips a user has viewed since the most recent `openedClip` event with an `openedReason` of `clipListTap` or `deepLink`. | 1, 2, 3, \u2026 |\n| Duration Viewed | `durationViewed` | In milliseconds, the duration the user viewed the Clips player for, measured from the most recent `openedClip` event with an `openedReason` of `clipListTap` or `deepLink`. | 1200, \u2026 |\n| Loops Viewed | `loopsViewed` | The total number of loops (plays of an individual Clip) a user has viewed since the most recent `openedClip` event with an `openedReason` of `clipListTap` or `deepLink`. | 1, 2, 3, \u2026 |\n\n## Finished Clip (`finishedClip`)\n\nThe `finishedClip` event is recorded at the same time as `openedCategory`, `dismissedClip`, `nextClip`, or `previousClip`.\n\nThe 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 Clip for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Content Length | `contentLength` | In seconds, the total duration of the Clip. | `15`, `21`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Duration Viewed | `durationViewed` | In milliseconds, the duration the user viewed the Clips player for, measured from the most recent `openedClip` event with an `openedReason` of `swipe`. | 1200, \u2026 |\n| Loops Viewed | `loopsViewed` | The total number of loops (plays of an individual Clip) a user has viewed since the most recent `openedClip` event with an `openedReason` of `swipe`. | 1, 2, 3, \u2026 |\n\n## Next Clip (`nextClip`)\n\nThe `nextClip` event is recorded when a user swipes up to go to the next Clip.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Previous Clip (`previousClip`)\n\nThe `previousClip` event is recorded when a user swipes down to go to the previous Clip.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Completed Loop (`completedLoop`)\n\nThe `completedLoop` event is recorded when a user completes a loop of a Clip. It is never recorded for live Clips.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Action Button Tapped (`actionButtonTapped`)\n\nThe `actionButtonTapped` event is recorded when a user taps the action button at the bottom of a Clip.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Share Button Tapped (`shareButtonTapped`)\n\nThe `shareButtonTapped` event is recorded when a user taps the share button on a Clip.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Share Success (`shareSuccess`)\n\nThe `shareSuccess` event is recorded when a user successfully shares a Clip.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n| Share Method | `shareMethod` | Always an empty string for Clips. | `''` |\n\n## Paused Clip (`pausedClip`)\n\nThe `pausedClip` event is recorded when a user taps on the screen while a Clip is playing to pause the Clip. It is not recorded when a Clip pauses automatically because the user shares it or follows an action. It is never recorded for live Clips, because live Clips cannot be paused or resumed.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Resumed Clip (`resumedClip`)\n\nThe `resumedClip` event is recorded when a user taps a paused Clip to resume playback. It is not recorded when a Clip resumes automatically, for example after the user finishes sharing it. It is never recorded for live Clips, because live Clips cannot be paused or resumed.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Liked Clip (`likedClip`)\n\nThe `likedClip` event is recorded when a user taps the like button on a Clip they have not liked.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Unliked Clip (`unlikedClip`)\n\nThe `unlikedClip` event is recorded when a user taps the like button on a Clip they have liked.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Clip. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Opened Category (`openedCategory`)\n\nThe `openedCategory` event is recorded when:\n\n- A user taps a Category at the bottom of the Clips player to open a new Category\n- A user opens a Category by navigating back from another Category\n\nOpening the Clips player with `openCollection(collectionId, { categoryId })`\nshows the Clips of that Category without recording this event.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list with the Category Detail object of the Category being navigated to. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Category ID | `categoryId` | The ID of the Category being navigated to. | `012200025`, `12312452`, \u2026 |\n| Category Name | `categoryName` | The name of the Category being navigated to. | \u201cMust See Moments\u201d, \u201cRapid Replay\u201d, \u2026 |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Dismissed Category (`dismissedCategory`)\n\nThe `dismissedCategory` event is recorded when a user navigates back to the previous Category with the back button. It is not recorded when the user dismisses the top level Collection.\n\nThe 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 external IDs of the categories assigned to the Clip for which the event occurred. | [\"game-0012200025\", \"recap\"] |\n| Category Details | `categoryDetails` | A list with the Category Detail object of the Category being dismissed. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Category ID | `categoryId` | The ID of the Category being dismissed. | `012200025`, `12312452`, \u2026 |\n| Category Name | `categoryName` | The name of the Category being dismissed. | \u201cMust See Moments\u201d, \u201cRapid Replay\u201d, \u2026 |\n| Collection | `collection` | The ID of the Collection, if the Clip is being played from one. | `live-stories`, `top-stories`, \u2026 |\n| Clip ID | `clipId` | The ID of the Clip for which the event occurred. | `3241dbc1-ae7b-4b55-a236-1294f18e2584` |\n| Clip Index | `clipIndex` | The index of the Clip in the row or grid at the point it was selected, or the index of the Clip in the feed at the point it was viewed (if the Clip wasn\u2019t opened from a row or grid). This property uses 1-based indexing. | 1, 2, 3, \u2026 |\n| Clip Title | `clipTitle` | The title of the Clip for which the event occurred. | \"Highlights\", \"Tonight's Movies\" |\n| Clip Has Action | `clipHasAction` | Whether the Clip associated with the event contains an Action. | `true`, `false` |\n| Clip Action Text | `clipActionText` | If the Clip associated with the event has an Action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cWatch Now\u201d, \u2026 |\n| Clip Action URL | `clipActionUrl` | If the Clip associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n", "copy_markdown_include_header": false, "base_path": "", "ai_dir": "ai", "missing_payload_behavior": "empty"}