Object listing all the interactions a user does.
Your access to personalized interactions depends on your subscription plan.
Endpoint - GET /$source/users/$userID/interactions
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}}/interactions \
-H 'x-api-key: Your_Rumo_API_Key' \
Example request (with parameters):
curl -X GET \
https://beta.api.rumo.co/{{$source}}/users/{{$userID}}/interactions?catalogs={{$catalogID}} \
-H 'x-api-key: Your_Rumo_API_Key' \
JSON response
[
{
"key": {
"source": "RumoAPI",
"userId": "1"
},
"type": "Click",
"contentId": "123",
"timestamp": "2019-08-19T10:33:03.171Z"
},
{
"key": {
"source": "RumoAPI",
"userId": "1"
},
"type": "Click",
"contentId": "1",
"timestamp": "2019-08-17T22:29:39.754Z"
},
{
"key": {
"source": "RumoAPI",
"userId": "1"
},
"type": "Purchase",
"contentId": "1",
"timestamp": "2019-08-17T22:29:26.027Z"
},
{
"key": {
"source": "RumoAPI",
"userId": "1"
},
"type": "Watch",
"contentId": "1",
"timestamp": "2019-08-17T22:12:29.073Z"
},
{
"key": {
"source": "RumoAPI",
"userId": "1"
},
"type": "Watch",
"contentId": "1",
"timestamp": "2019-08-17T11:26:11.250Z"
}
]
Parameter | Status | Description |
---|---|---|
content-id |
Optional | Filter interactions for single content id. |
type |
Optional | Filter interactions by type. |
skip |
Optional | Integer used to skip the first results that would be displayed. For example, skip=5 means not showing the first 5 results. Default value=0. |
limit |
Optional | Integer to define the number of results requested. Default value=10. |
take |
Optional | Integer used to define the number of returned interactions (Will be deprecated in the future). |
Returns | Level | Description |
---|---|---|
key |
1 | String map with the identification of the source and the userId. |
source |
2 | String identifying your business content database. |
userId |
2 | String identifying the user. |
type |
1 | String identifying the $interactionType , which must be one of Click, Play, Watch, Bookmark, Preview, Purchase, RateLike, or RateDislike. |
contentId |
1 | String identifying the content piece. |
timestamp |
1 | String identifying the timestamp. |