Rails analytics for OpenTV and Data Warehouse

The following table lists the Rails-specific actions and activities for reporting. See Reporting activity and event metrics from client devices for the full reporting guide.

These actions listed below are specific to and only relevant for Rails.

Activity name

Trigger

Description

Message metadata keys

Notes

Examples

RAIL_View

Created when the Rail is shown on the screen (user engagement measure)

appSessionId

sessionId

templateId

railId

depth

deviceId

accountId

userId

Request

CODE

POST API https://<server>/useractivityvault/v1/useractivity/railView

Payload

CODE

{
 "accountId": "60ab88ccb780b5233dfec9cd",
 "userId": "",
 "key": "GLOBAL_20711",
 "deviceId": "60acc1efba91e2032c508e50",
 "name": "railView",
 "timestamp": "2020-03-20T10:53:19Z",
 "metadata": {
    "contentType": "live-stcu-event",
    "sessionId" : "<UUID>",
    "appSessionId" : "<UUID>",
    "depth" : "",
    "railId" : "<UUID>",
    "templateId" : "<UUID>"
  }
}

RAIL_Selection

Created when a user selects a Rail item to open the media card/more detail

appSessionId

sessionId

templateId

railId

sectionId

editorialID

Type

deviceId

accountId

userId

deeplinkProviderId

providerResourceId

Request

CODE

POST API https://<server>/useractivityvault/v1/useractivity/railSelection

Payload

CODE

{
 "accountId": "60ab88ccb780b5233dfec9cd",
 "userId": "",
 "key": "",
 "deviceId": "60acc1efba91e2032c508e50",
 "name": "railSelection",
 "timestamp": "2020-03-20T10:53:19Z",
 "metadata": {
    "contentType": "live-stcu-event",
    "sessionId" : "<UUID>",
    "appSessionId" : "<UUID>",
    "sectionId" : "",
    "railId" : "<UUID>",

 "editorialID" : "GLOBAL_20711"

 "providerResourceId" : "",

 "deeplinkProviderId" : "",
    "templateId" : "<UUID>"  }
}