Most Popular Items

The Most Popular Items algorithm recommends items by analyzing the most popular products by page views. It generates recommendations based on the page view counts during the last 30 days. The Most Popular Items algorithm works best on main, category, and product pages.

Endpoint

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

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 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 details of variant products	String	No
excludeVariants	true	Exclude variants from the response.	Boolean	No
userId	a1b2c3d4	User identifier, which 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 products of the response	Boolean	No
productId	ABC123CBA	Current product ID	String	No

Algorithm Customization

The Most Popular Items algorithm also provides users with product recommendations based on their popularity within categories. To obtain category-based most popular products, the API endpoint should include the categoryList parameter with valid category values from the Product Catalog.

Variant Name	Condition	Parameter(s)
Most Popular Items of Partner	No category filter	Default (no categoryList)
Most Popular Items of Category	Category filter provided	categoryList=[category1, category2, ...]

When categoryList is provided, recommendations are filtered to show only the Most Popular products within the specified categories. Recommendations served in the API response will be abbreviated as mvoc for Most Popular Items of Category recommendations.

Sample Request

The sample below displays a request to Most Popular Items, an algorithm that recommends products with the highest overall engagement based on page views.

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

Sample Response

{
    "success": true,
    "total": 1,
    "types": {
        "mvop": 1
    },
    "data": [
{
            "image_url": "test.image_url.com",
            "name": "Original Air-dried Beef recipe for dogs",
            "item_id": "46177313784082",
            "url": "test.url.com",
            "description": "Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.",
            "in_stock": 1,
            "price": {
                "USD": 29.58
            },
            "groupcode": "8528988209426",
            "locale": "en_US",
            "product_attributes": {
                "activation_date": "2023-08-11",
                "shopify_tag": [
                    "air-dried",
                    "beef",
                    "dog"
                ]
            },
            "stock_count": 99,
            "category": [
                "Dog Food",
                "Pets Collection"
            ],
            "discount": {
                "USD": 0.0
            },
            "original_price": {
                "USD": 29.58
            }
        }
    ]
}

Sample Request for Most Popular of Category

https://recommendation.api.useinsider.com/v2/most-popular?locale={Locale}&partnerName={PartnerName}&categoryList=[“Dog Food”]

Sample Response

{
    "success": true,
    "total": 1,
    "types": {
        "mvoc": 1
    },
    "data": [
{
            "image_url": "test.image_url.com",
            "name": "Original Air-dried Beef recipe for dogs",
            "item_id": "46177313784082",
            "url": "test.url.com",
            "description": "Having access to lush fields of grass year-round makes New Zealand free-range, grass-fed beef among the best in the world.",
            "in_stock": 1,
            "price": {
                "USD": 29.58
            },
            "groupcode": "8528988209426",
            "locale": "en_US",
            "product_attributes": {
                "activation_date": "2023-08-11",
                "shopify_tag": [
                    "air-dried",
                    "beef",
                    "dog"
                ]
            },
            "stock_count": 99,
            "category": [
                "Dog Food",
                "Pets Collection"
            ],
            "discount": {
                "USD": 0.0
            },
            "original_price": {
                "USD": 29.58
            }
        }
    ]
}

Fallback Algorithms

If the products come from Most Popular Items are not enough to fill the response data, some fallback algorithms below fill it:

Most viewed items of the category, including the rightmost item in the categoryList