Most Valuable Products

The Most Valuable Products algorithm recommends items based on their contribution to total revenue. It recommends products that generate more revenue across your site. Products are recommended based on the contribution to revenue and revenue per visit. This type of algorithm can be used on all page types.

Endpoint

GET https://recommendation.api.useinsider.com/v2/most-valuable

Query Parameters

Parameter	Sample Value	Description	Data Type	Required
partnerName	mybrand	Partner Identifier assigned by Insider One. You can use PartnerID as well.	String	Yes
locale	us_US	Locale of the requested product catalog	String	Yes
platform	web	Requested platform. Web comes by default.	Enum	No
currency	USD	Requested currency of the products. If no value is set, the default currency in your settings is used.	String	No
size	50	Required number of items in response. Valid values are 0 to 100.	Integer	No
categoryList	[“Clothes”, “Skirts”]	Category filter of the products	Array (of string)	No
filter		Smart Recommender filtering. There can be more than one filter parameter.	String	No
details	true	Adds details to the products of the response.	Boolean	No
shuffle	false	Shuffles the products of the response.	Boolean	No
getGroupProducts	false	Shows variant products under the products of the response	Boolean	No
groupProductsFields		Adds these fields to the variant products’ details	String	No
excludeVariants	true	Exclude variants from the response	Boolean	No
userId	a1b2c3d4	User identifier that is assigned by Insider One	String	No
excludeViewDay	30	After how many days should viewed products be excluded	Integer	No (Can be used only with userId)
excludeViewItem	100	How many viewed products should be excluded	Integer	No (Can be used only with userId)
excludePurchaseDay	30	After how many days should purchased products be excluded	Integer	No (Can be used only with userId)
excludePurchaseItem	100	How many purchased products should be excluded	Integer	No (Can be used only with userId)
hp	false	Makes affinities affect the products of the response	Boolean	No
productId	ABC123CBA	Current product ID	String	No

Sample Request

The sample below displays a request to Most Valuable Products, an algorithm that recommends items based on their contribution to total revenue:

https://recommendation.api.useinsider.com/v2/most-valuable?locale={Locale}&currency={Currenct}&partnerName={PartnerName}

Sample Response

{
    "success": true,
    "total": 10,
    "types": {
        "mpop": 10
    },
    "data": [
        "QAZ-7890",
        "XYZ-1234",
        "QAZ-7899",
        "XYZ-1233",
        "QAZ-7898",
        "XYZ-1243",
        "QAZ-7891",
        "XYZ-1223",
        "QAZ-7892",
        "XYZ-1342"
    ]
}

Fallback Algorithms

If the products from Most Valuable Products are not enough to fill the response data, some fallback algorithms below fill it:

Most valuable products of the category, including the rightmost item in the categoryList.