Report user activity (Recommendations Façade with XroadMedia NCanto)

Request

Prior to release 21.38, clients were required to report activity and metrics separately to both Recommendations Façade and to User Activity Vault (UAV). (The latter is required for reporting purposes.)

Since release 21.38, clients only need to report activity and metrics to UAV – they will be passed on to Recommendations Façade automatically without the client having to report them separately.

That means that the client no longer needs to make the request described on this page.

To record user activity against the provided content, send a POST request to:

/recommendations/v1/useractivity

Headers

• Content-Type: application/json
• Authorization – the token obtained from IAS at signon

Mandatory Arguments

• accountId (from token) – the ID of the account
• activityType – a configurable attribute to describe the activity being reported. e.g. 
  • download
  • watch
  • bookmark
  • record
  • watchtrailer
  • play
  • purchase
  • setreminder
  • like
  • dislike
• deviceType – the device type
• content – the ID of the content to which the activity relates - one of 
  • VOD
  • BTV
  • SERIES
  • SEASON
  • DEEPLINK

The criteria submitted to the generic API is converted into an Ncanto interaction which is submitted as the POST body to <ncanto-host>/log 

Response

A successful request returns an HTTP 202 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 500 status.