/personalized-recommendation

This page explains the request and response formats of 'personalized-recommendation' endpoint of Frenzy Search. It also provide examples to help you understand better.

Personalized Recommendations are based on the User Activity. API uses most recent events like recommendations, search, add to cart, add to wishlist, etc for each user to find the products that match the User's Interests.

NOTE: To use personalized recommendations make sure that 'user_id' is being sent to the Search ('/') and the Recommendations ('/recommendation') endpoint. This allows the API to track user-specific events.

GET https://xyz.search.frenzy.ai/personalized-recommendation

Get top N products relevant to the user activity.

Query Parameters

Name	Type	Description
user_id*	string	User Id associated with the request
num_matching*	integer	Required number of matching products
full_description	boolean	To get all products with their attributes set it to true. (Default false)
shop	string	name of the Shopify Store. (required for shopify stores)

Headers

Name	Type	Description
X-Frenzy_Authorization*	string	API key provided at the time of account creation.

200: OK Top N matching products for the given user-id are successfully retrieved.

Success

{  // list of matching products
  "matching_products": [
    "PSS-001-00001",
    "PSS-002-00002",
    ....
    ...
    ...
    "PSS-010-00015"
  ]
}

Success(full_description=true)

{
  "matching_products": [
  
    // description for product 1
    
    {
    'brand' :  " ",
    'category' : " ",
    ...
    ...
    ..
    'sku' : "PSS-001-00001"
    },
    
    // description for product 2 
    {
    'brand' :  " ",
    'category' : " ",
    ...
    ...
    ..
    'sku' : "PSS-002-00002"
    },
    ....
    ...
    ..
    
    // description for product N
    
    {
    'brand' :  " ",
    'category' : " ",
    ...
    ...
    ..
     'sku' : "PSS-010-00015"
    }
  ]
}

Failure

{'error': 'server_error'}

NOTE: For Shopify Customers

1. num_matching = is set in the portal

Response Object

Key	Type	Value
matching_products	array	Top N matching products
request_id	string	Id to track the request

Example Request

By default, the request will return only the list of matching product-ids.

curl --location --request GET 'https://xyz.search.frenzy.ai/personalized-recommendation?user_id=1002&num_matching=15' \
--header 'X-Frenzy-Authorization: API_KEY'

Example Request (full_description = true)

To get all product attributes along with product-ids, set the full_description parameter to true.

curl --location --request GET 'https://xyz.search.frenzy.ai/personalized-recommendation?user_id=1002&num_matching=15&full_description=true' \
--header 'X-Frenzy-Authorization: API_KEY'