Skip to main content

Rating request data model

This is a JSON object with the following fields:

Name
Type
Description
Required
contentIdStringThe content ID to be the basis of recommendation.Yes
dataTypeString

The type of content. One of:

  • btv
  • vod
Yes
entityString

The type of entity that the rating applies to. One of:

  • content – a single BTV or VOD content (the default)
  • series – a BTV or VOD series
  • product – another type of product (e.g., a content bundle)
No
deviceTypeString

The type of device. One of:

  • settopbox
  • mediaplayer
Yes
ratingIntegerThe rating.Yes
timestampISO dateThe time of the activity.No

Example

JS
{
    "dataType":"vod",
    "deviceType":"SetTopBox",
    "contentId":"TDLA0100000088341751",
    "rating":"3",
    "timestamp":"2017-07-17T12:20:02.000Z"
}

Example

JS
{
    "dataType":"btv",
    "deviceType":"SetTopBox",
    "entity" : "series",
    "contentId":"TDLA0100000088342567",
    "rating":"2",
    "timestamp":"2017-07-16T22:01:03.000Z"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.