Retrieving Personalized Recommendation

Object listing content recommendations using the user’s taste and feedback profile.

Your access to personalized recommendations depends on your subscription plan.

Endpoint - GET /$source/users/$userID/recommendation

Header Value Description
x-api-key Your API key String representing the value of the API key we sent you when you joined Rumo.


Example request:

curl -X GET \
  https://beta.api.rumo.co/{{$source}}/users/{{$userID}}/recommendation \
  -H 'x-api-key: Your_Rumo_API_Key' \


Example request (with parameters):

curl -X GET \
  https://beta.api.rumo.co/{{$source}}/users/{{$userID}}/recommendation?take={{$take}}&catalogs{{$catalogID}}&at={{$YYYY-MM-DD}} \
  -H 'x-api-key: Your_Rumo_API_Key' \


JSON response

{
    "id": "1",
    "content": [
        {
            "id": "123",
            "score": 4.875551549687884E-5
        },
        {
            "id": "1",
            "score": 0.9901253529737497
        },
        {
            "id": "3",
            "score": 0.997672523375305
        },
        {
            "id": "2",
            "score": 1.0
        }
    ]
}


Parameter Status Description
take Optional Integer used to define the number of returned recommendations.
catalogs Optional List of strings showing filtered recommendations based on catalog.
algo Optional String showing the recommendation algorithm to use. Could be Jaccard Index (with non-weighted categories) or Cosine Similarity (with weighted categories).


Returns Level Description
id 1 String used to identify a content piece.
content 1 String map with similar content IDs and corresponding scores.
id 2 String used to identify content pieces similar to the one recognized at level 1.
score 2 Integer identifying the relevance of the content piece.