userInfo
Important: Only call parameters that you need. Personalization Cloud operates off a set of APIs that support many applications and clients concurrently. Personalization Cloud may update and enhance these APIs at any time.
http://recs.richrelevance.com/rrserver/api/rrPlatform/userInfo
Note: The URL requires the API key and parameter(s) to function properly. See below for more information on example URL requests.
Parameters
Note: All parametrs are case sensitive.
Name | Required or Optional | Description |
---|---|---|
apiClientKey |
Required | |
apiKey |
Required | |
attribute |
Optional | |
categoryData |
Optional | |
count |
Optional | |
includeSimilarUsers |
Optional | |
preferences | Optional |
True/False. The default value is false. If set to true, any available SKU Affinity related data provided in the SKU Feed will be shown for that user. This will be the same information as generated from the SKU Affinity job and SKU Affinity model. If the SKU Affinity job is not executed, the information will not be available. Example: preferences=true Example JSON response format: {"purchasedProducts":[], "viewedProducts":[], "preferences":[ { "contextCategoryId":"", "score":1, "attributeValue":"24", "contextAttributes":{ "size_type":"Footwear" }, "attributeName":"size" }, { "contextCategoryId":"", "score":1, "attributeValue":"L", "contextAttributes":{ "size_type":"Bottoms" }, "attributeName":"size" }, { "contextCategoryId":"", "score":1, "attributeValue":"S", "contextAttributes":{ "size_type":"Tops_bottomsCombo_Jumpsuits" }, "attributeName":"size" }, { "contextCategoryId":"", "score":1, "attributeValue":"M", "contextAttributes":{ "size_type":"Tops" }, "attributeName":"size" }, { "contextCategoryId":"", "score":1, "attributeValue":"M", "contextAttributes":{ "size_type":"Socks" }, "attributeName":"size" } ], "similarUsers":[], "viewedCategories":[], "purchasedCategories":[] }
When set to false, SKU Affinity related fields will not be shown and the API response will be the same as the existing behavior. Example: preferences=false Example JSON response format: {"purchasedProducts":[], "viewedProducts":[], "similarUsers":[], "viewedCategories":[], "purchasedCategories":[] } |
recentlyPurchased |
Optional | |
recentlyViewed |
Optional | |
recentSearches |
Optional | |
sessionId |
Optional | |
similarUsersCount |
Optional | |
similarUsersStrategy |
Optional | |
useCookie |
Optional | |
userAttribute |
Optional | |
userId |
Required |
Example Request
http://integration.richrelevance.com/rrserver/api/rrPlatform/userInfo?&apiClientKey=e9c9e05289be70e6&apiKey=showcaseparent&userId=1
Example Response
{ "purchasedProducts": [], "viewedProducts": [{ "regionPriceDescription": "", "rating": 4.254000186920166, "numReviews": 0, "priceRangeCents": [79900, 79900], "categoryIds": ["Electronics", "Electronics.TV & Video", "Electronics.TV & Video.TVs"], "imageURL": "http://labs.richrelevance.com/storre/media/catalog/product/v/i/vizio-e601i-a3-60quot-1080p-120hz-class-razor-led-1.94quot-ultra-slim-smart-hdtv-quotvizio-direct-refurbishedquot-9fe3cd76f6142358157dfc008d38aff2.jpg", "name": "VIZIO E601i-A3 60\" 1080p 120Hz Class Razor LED (1.94\" ultra-slim) Smart HDTV, \"VIZIO Direct Refurbished\"", "genre": "Electronics", "isRecommendable": true, "priceCents": 79900, "id": "24516217", "categories": [{ "hasChildren": false, "name": "Electronics", "id": "Electronics" }, { "hasChildren": false, "name": "TV & Video", "id": "Electronics.TV & Video" }, { "hasChildren": false, "name": "TVs", "id": "Electronics.TV & Video.TVs" }], "brand": "Vizio" }], "similarUsers": [], "viewedCategories": [{ "hasChildren": false, "name": "Electronics", "id": "Electronics" }, { "hasChildren": false, "name": "TVs", "id": "Electronics.TV & Video.TVs" }, { "hasChildren": false, "name": "TV & Video", "id": "Electronics.TV & Video" }], "purchasedCategories": [] }