Once you've created a recommendation, you can retrieve the generated recommendation data through the Recommendations API:
For the complete API specification, including detailed information about request parameters and error responses, see the Recommendations API guide.
The URL for Recommendations API requests is
<platform_instance> is the domain name of your Frosmo Platform instance. To find out the domain name, see the Recommendations API guide.
The API does not require authentication.
The API supports the following standard HTTP methods:
The only difference between the two is that with GET you provide the recommendation details in the request URL, while with POST you provide the details in the request body. If your GET request URL exceeds the maximum URL length, use a POST request instead.
To retrieve recommendation data using the GET method, make the following request:
To retrieve recommendation data using the POST method, make the following request:
Table: Query parameters for Recommendations API requests
To find out your site's origin, see Getting your site origin.
Information about what recommendation data to retrieve and, if appropriate, how to filter the returned data.
You can retrieve the data for one or more recommendations. You specify each recommendation in its own JSON object.
The array must not be empty (
If you want to guarantee a fast response, limit the number of recommendations to four. You can retrieve the data for five or more recommendations in the same request, if you want, but the platform may then take longer to respond.
|Array of recommendation objects (JSON)||Required/Optional|
Retrieve the data for one recommendation:
Retrieve the data for two recommendations:
Table: Recommendation object properties
Request parameters defined in the recommendation configuration. Use the parameters to filter the generated recommendation data.
You must include each parameter defined in the recommendation configuration. The parameter values must exactly equal the product data field or segment values (case insensitive) by which you want to filter the results.
If your recommendation type is
If your recommendation type is
Request parameter defined in the recommendation configuration. Use the parameter to filter the generated recommendation data.
You can define either a single string or an array of strings as the parameter value. In the latter case, the recommendation data is filtered separately by each string value.
If a parameter maps to a source data field that has a Boolean or number value, such as product price, you nonetheless define the parameter value as a string. For example, define the Boolean
|String or array of strings||Required|
Filter by originally boolean and numeric values:
IDs of the products to exclude from the recommendation data.
This property is only valid for product recommendations.
|Array of strings||Optional|
Exclude products 123, 456, and 789 from the recommendation data:
The response body is an object that contains the
data array. Each item in the
data array stores the data for a single recommendation.
The data for a single recommendation is returned as an array of objects, where each object contains the data for a single recommended product.
Depending on the
map_ids parameter defined for the recommendation, each product object contains either the raw recommendation data for the product (no mapping) or the full set of product data retrieved from the Frosmo back end (mapping to data).