userInfo

Last updated
Save as PDF

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.

Description: Returns information about the user’s purchase and view history.

Parameters

Note: All parametrs are case sensitive.

Name	Required or Optional	Description
apiClientKey	Required	A unique key specific to each API implementation. It identifies the specific application or client for reporting, permissions, and merchandising. This is provided by RichRelevance. Example: apiClientKey=b0126f995ac848159d
apiKey	Required	A unique key that identifies the site. Each RichRelevance client has a unique API key to separate data and traffic from other clients. This is provided by RichRelevance. Example: apiKey=4faeaf752ee40a0f
attribute	Optional	Retrieves custom attributes provided in the catalog feed. Use this parameter multiple times to request more than one attribute by separating each attribute with the ampersand "&" character. Use the asterisk "" character as the parameter value to request all attributes. Example: &attribute=COLOR&attribute=SIZE*
categoryData	Optional	Omits category data (categoryIds and categories) when set to false. The default is true. Example: categoryData=false
count	Optional	The total number of products to return in the response. This value overrides the return count set in the placement or in the Search and Browse configuration. For example, if you want to return products 30 through 60, set the value to 30. The maximum value is 1000. Example: count=30 Note: This is for Search and Browse only. When using pagination this parameter together with st is required.
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	Products the shopper has purchased in the current session. This can be a single product ID or list of product IDs. Products listed here will be considered along with historical data from the RichRelevance system. Use the pipe "\|" character to separate the product IDs. Example: recentlyPurchased=uv2345\|xt1234
recentlyViewed	Optional	List product IDs of the product detail pages viewed by the shopper in the current session. Include time stamps in milliseconds using UTC time zone for each view. The timestamp field must be provided. Use the pipe "\|" character to separate multiple product IDs and time stamps. If there are multiple views for a product ID, the time stamps can be concatenated using a semicolon. Example: recentlyViewed=pid1:1409871261000;1409871561000\|pid2:1409761261000
recentSearches	Optional	Recent searches performed by the shopper. Separate multiple searches by using the the pipe "\|" character. This parameter is required for recs on searches. Example: recentSearches=brown shoes\|blue shoes
sessionId	Optional	Identifies a single visit by a shopper. Sessions are used by behavioral models (to scope user behaviour in a shopping session) and reporting metrics. Example: sessionId=93484
similarUsersCount	Optional	Number of similar users to return. Default: 30 Example: similarUsersCount=50
similarUsersStrategy	Optional	Choose the strategy to use when finding similar users when includeSimilarUsers=true. Valid values: attributeOnly or attributeBehavioral. Default = attributeOnly Example: similarUsersStrategy=attributeOnly
useCookie	Optional	Use recently viewed product information from the RichRelevance cookie as a basis for recommendations along with manually-given recommendations. Default is yes. Example: useCookie=yes
userAttribute	Optional	Custom keys and values that describe the current shopper. Separate information using a semicolon and the pipe "\|" character. Example: userAttribute=eye_color:blue;green\|hair_color:brown
userId	Required	User ID. A unique string to identify each shopper (user). All shopper behavior is stored using this key. It is case-sensitive, and should be the same user ID sent to RichRelevance in other applications. Example: userId=0982347

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": []
}