Product Recommendation

Introduction

The Recommendations Search API from Criteo allows you to retrieve personalized product recommendations based on specific parameters enhancing your platform's user experience. By utilizing this API, you can deliver targeted content to your users and improve engagement.

Product Recommendations use our deep understanding of each shopper’s individual habits to serve up personalized items tailored to your goals.

⚠️
To fully use our app you need to have read access to the Product Recommendation domain. To set up it please reach out to Criteo Support ([email protected]).

Recommendation Search API Endpoint

 https://api.as.criteo.com/preview/recommendation/search

Body Parameters

Parameter	Description	Sample Value
`nbRequestedProducts` number (mandatory)	Number of recommended products to be returned (up to 13 products)	5
`PartnerId` number (mandatory)	Also known as DataSet. Is the partner ID of the advertiser.	19825
`AdSetId` number (mandatory)	Ad Set ID of the advertiser. Check Ad Set for more information.	380313
`AdId` number (optional)	Ad ID of the advertiser. Used to activate the product set reco filter feature. Check Ads for more information.	1366052
`userId` string (mandatory)	User ID in the form of `cto_bundle` which is Criteo first-party cookie, enabling personalized marketing. Only for users who have provided appropriate related consent.	zCZWYF83T0ZDMDFhNHhkN3ZmaGxKUU9DUWdEQTlIblpFRWVWZU5RS0Q4dUhBSmFJOGolMkZTUjNoTTF2TmFLSGVFTmRQTTJpUDREWG44MHlyaFBEamwlMkZFJTJCV3dLdElqajElMkZNUFJ3ZHJUJTJGcEI4N25JNW0yYkkzZUVIMiUyQmNVMTZUZUNCNFk3S1lCeFlUbnRBdzNMcUFacGJITDRqbFElM0QlM0Q

Sample payload

{
    "nbRequestedProducts": 2,
    "PartnerId": 98687,
    "AdSetId": 380313,
    "userId": "zCZWYF83T0ZDMDFhNHhkN3ZmaGxKUU9DUWdEQTlIblpFRWVWZU5RS0Q4dUhBSmFJOGolMkZTUjNoTTF2TmFLSGVFTmRQTTJpUDREWG44MHlyaFBEamwlMkZFJTJCV3dLdElqajElMkZNUFJ3ZHJUJTJGcEI4N25JNW0yYkkzZUVIMiUyQmNVMTZUZUNCNFk3S1lCeFlUbnRBdzNMcUFacGJITDRqbFElM0QlM0Q"
}

Sample response

{
    "products": [
        {
            "productExternalId": "24",
            "clickUrl": "https://cat.jp2.as.criteo.com/delivery/ckn.php?cppv=3&cpp=ez08j8mil6JjsgJoYK2iNk0VYm0VuJ0LZY1jkXBV8yIBqUEozL1XTuaCMiHWVBQlSrhMoD_Owjs0TKLOlcYWojrPY9uycxxyrHgQKgztnJCweQfixnCq6vFhPBuwqokGafSYzMmHIulBK0G_6mqCOikEs_NkOSMrtWH8Vfnw5l4ZL_9NJ40LDSsfJx7IXrbrWHQIwalLP0AbvVOqH5QJajDs_XDM5XEnAmSzjKhN8601FLL3&maxdest=https%3A%2F%2Fwww.demoecstore.com%2Fproduct%2Falbum%2F",
            "imageUrl": "https://www.demoecstore.com/wp-content/uploads/2023/01/album-1.jpg",
            "name": "Album",
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum sagittis orci ac odio dictum tincidunt. Donec ut metus leo. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed luctus, dui eu sagittis sodales, nulla nibh sagittis augue, vel porttitor diam enim non metus. Vestibulum aliquam augue neque. Phasellus tincidunt odio eget ullamcorper efficitur. Cras placerat ut turpis pellentesque vulputate. Nam sed consequat tortor. Curabitur finibus sapien dolor. Ut eleifend tellus nec erat pulvinar dignissim. Nam non arcu purus. Vivamus et massa massa.",
            "price": 15.0,
            "googleCategory": "Music"
        },
        {
            "productExternalId": "30",
            "clickUrl": "https://cat.jp2.as.criteo.com/delivery/ckn.php?cppv=3&cpp=ez08j8mil6JjsgJoYK2iNk0VYm0VuJ0LZY1jkXBV8yIBqUEozL1XTuaCMiHWVBQlSrhMoD_Owjs0TKLOlcYWojrPY9uycxxyrHgQKgztnJCweQfixnCq6vFhPBuwqokGafSYzMmHIulBK0G_6mqCOikEs_NkOSMrtWH8Vfnw5l4ZL_9NJ40LDSsfJx7IXrbrWHQIwalLP0AbvVOqH5QJajDs_XDM5XEnAmSzjKhN8601FLL3&maxdest=https%3A%2F%2Fwww.demoecstore.com%2Fproduct%2Fhoodie%2F%3Fattribute_pa_color%3Dgreen%26attribute_logo%3DNo",
            "imageUrl": "https://www.demoecstore.com/wp-content/uploads/2023/01/hoodie-green-1.jpg",
            "name": "Hoodie - Green, No",
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum sagittis orci ac odio dictum tincidunt. Donec ut metus leo. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed luctus, dui eu sagittis sodales, nulla nibh sagittis augue, vel porttitor diam enim non metus. Vestibulum aliquam augue neque. Phasellus tincidunt odio eget ullamcorper efficitur. Cras placerat ut turpis pellentesque vulputate. Nam sed consequat tortor. Curabitur finibus sapien dolor. Ut eleifend tellus nec erat pulvinar dignissim. Nam non arcu purus. Vivamus et massa massa.",
            "price": 45.0,
            "googleCategory": "Hoodies"
        }
    ],
    "extraInfos": null
}