Retrieving Profile

Object returning the profile of a user used to personalize recommendations.

Your access to retrieving profile depends on your subscription plan.

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

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/profile \
  -H 'x-api-key: Your_Rumo_API_Key' \


JSON response

[
    {
        "source": "RumoAPI",
        "userId": "1",
        "categories": {
            "Scenario": {
                "Relationship": 140,
                "Pursuit": 100,
                "Romantic Dilemma": 140,
                "Mysterious Deaths": 100,
                "Investigation": -200
            },
            "Character": {
                "Media Professionals": 70,
                "Wrongly Accused Persons": 100,
                "Victims": -200,
                "Love Interests": 140,
                "CEOs": 70
            },
            "genres": {
                "Animated": 100,
                "Documentary": -100,
                "Sitcom": 200
            },
            "Theme": {
                "Consequences": -200,
                "Discovery": 170,
                "Empowerment": 280,
                "Friendship": 370
            },
            "Video Mood": {
                "Witty": 140,
                "Sober": -200,
                "Charming": 210,
                "Intense": 70
            }
        }
    }
]


Returns Description
source String identifying your business content database.
userId String identifying the user.
categories Field value object, where fields can be anything and are used to classify each content piece. The field value can be either a string map (non-weighted categories), or an object map (weighted categories).