App action metrics

Common fields

The following fields must be included in every request body:

accountId – the account ID
userId – must be an empty string
deviceId – the device ID
key – must be an empty string
name – the activity name
timestamp – the activity timestamp in <YYYY>-<MM>-<DD>T<hh>:<mm>:<ss>Z format

These fields are not included in the examples in the following table.

Activity name	Trigger	Description	Required data fields	Notes	Examples
`thirdPartyAppStart`	To be created when a third-party application is triggered/opened on the launcher	Capture the act of starting a third-party application due to a deep link or the client acting as a launcher (Netflix, Prime, etc.).	`appSessionId` `playbackSessionId` `appName` `appReference` `deeplinkProviderId` `railId` `templateId` `deviceId` `accountId` `userId`	Deep link provider is the provider of the deep-linked content (e.g., Disney, Prime, etc .).	Request: CODE `POST https://<server>/useractivityvault/v1/useractivity/thirdPartyAppStart` Body: JSON `{ ... "metadata": { "contentSource": "IPTV", "contentType": "TPAS", "playbackSessionId": "<UUID>", "appSessionId": "<UUID>", "appName" : "", "appReference": "", "railId" : "<UUID>", "templateId" : "<UUID>" } ... }`
`returnToLauncher`	To be created when the launcher becomes the active app	Launcher becomes active.	`appSessionId` `playbackSessionId` `appName` `deviceId` `accountId` `userId`		Request: CODE `POST https://<server>/useractivityvault/v1/useractivity/returnToLauncher` Body: JSON `{ ... "metadata": { "contentSource": "IPTV", "contentType": "RTL", "playbackSessionId": "<UUID>", "appSessionId": "<UUID>", "appName": "" } ... }`
`deepLinkTriggered`	To be created when a deep linked asset is selected via the client	Clicking through to watch content from a Rail or other client source on a deep link provider.	`appSessionId` `playbackSessionId` `deeplinkProviderId` `source` `editorialId` `providerResourceId` `railId` `templateId` `deviceId` `accountId` `userId`	Provider ID is the content ID as provided in the deep link data. Deep link provider is the provider of the deep-linked content (Disney, Prime, etc.).	Request: CODE `POST https://<server>/useractivityvault/v1/useractivity/deepLinkTriggered` Body: JSON `{ ... "metadata": { "appSessionId": "<UUID>\|<GUID>", "playbackSessionId": "<UUID>\|<GUID>", "contentSource": "[IPTV\|OTT\|Blend]", "contentType": "DLT", "providerResourceId": "<provider_resource_ID>", "deeplinkProviderId": "<deeplink_provider_ID>", "deeplinkId": "<UUID>\|<GUID>", "source": "<source>", "editorialId": "<editorial_ID>", "railId": "<UUID>\|<GUID>", "depth": "<depth>", "templateId": "<UUID>\|<GUID>" } ... }`
`downloadTriggered`	To be created when content is downloaded for watching off line, aka D2G.	For download to go, capture the action when a user triggers the download of content .	`appSessionId` `playbackSessionId` `editorialId` `railId` `templateId` `deviceId` `accountId` `userId`		Request: CODE `POST https://<server>/useractivityvault/v1/useractivity/downloadTriggered` Body: JSON `{ ... "metadata": { "contentType": "live-stcu-event", "playbackSessionId": "<UUID>", "appSessionId": "<UUID>", "railId": "<UUID>", "templateId": "<UUID>", "editorialId": "GLOBAL_20711" } ... }`

App action metrics

Common fields

`thirdPartyAppStart`

`returnToLauncher`

`deepLinkTriggered`

`downloadTriggered`