Personalized

Authentication

All endpoints require a valid auth JWT (Authorization). For profiles support a valid profile JWT (X-Profile) is also required. The profile JWT is obtained from the profiles service.

GET /personalized{?client}

Returns personalized recommendations.

  • Parameters
  • Name Description Required Type Example
    client

    Name of the client using this service

    Required string atv
  • Requests SHOW
  • > Authorization: Bearer <JWT>
    > X-Profile: Bearer <JWT>
  • Response 200 SHOW
  • {
      "data": {
        "user_id": "123456",
        "profile_id" : "default",
        "modules": [
          {
            "id": "c70f3f0a026c",
            "module": "top_picks",
            "recommendations": [
              {
                "type": "series",
                "series_id": "39049"
              },
              {
                "type": "movies",
                "video_id": "3960497"
              }
            ]
          }
        ],
        "algo": "algo-x"
      }
    }
    
    
  • Response 400 SHOW
  • Response 401 SHOW
  • Response 500 SHOW

Similars

GET /similars/<type>/<id>{?client,limit,version}

This endpoint is deprecated. Please use the /more-like-this endpoint of unified-search-gateway instead.

Returns movies and series similar to the given movie or series.

  • <type> must be either movie or series.

  • <id> is a video ID for type movie, series ID for type series.

  • Parameters
  • Name Description Required Type Example
    client

    Name of the client using this service

    Required string atv
    limit

    Maximum number of entries returned in the “similar” array

    integer 30
    version

    Specific recommendations version. Use this to lock the recommendations to the given version. If no version is given, the latest version as determined by the alphabetical (not numerical) order will be served.

    string v001-foo
  • Response 200 SHOW
  • {
      "data": {
        "input": {
          "type": "movie",
          "video_id": "1234567"
        },
        "similars": [
          {
            "type": "movie",
            "video_id": "3022886"
          },
          {
            "type": "series",
            "series_id": "34515"
          }
        ],
        "version": "v0"
      }
    }
    
    
  • Response 400 SHOW
  • Response 500 SHOW