Where to Make API Calls

Our API recognizes the following page types:

Search: Pages where users perform a keyword search, including the search bar dropdown.
Category: Includes category pages, category menu fly outs, and deals/promotional pages.
Product detail (PDP): Individual product pages.
Homepage: The main landing page of your site.
Checkout/Cart/Basket: Pages where users review their cart or initiate checkout.
Order confirmation: Pages confirming a transaction or purchase.

There is also a special "page type" called add-to-cart. In practice, this is not a dedicated page, but an event used to build our keyword model. More information about the keyword model can be found here.

Each page type is linked to valid values of the event-type parameter in the API call. More details can be found at API Parameters.

📘
General ad server requirement
You can find the general ad server requirements here.

Recommended API Call Practices

Make ad calls on every page load: Ideally, make API calls on every page load to ensure comprehensive data collection and ad delivery.

Prioritization guidelines

If making calls on every page load is not possible, follow this prioritization:

Search pages: This is the best performing page type but to be fully optimized it requires the PDP and Add-to-cart events to be integrated as well. These events are essential for building the keyword model for Sponsored Products even if no ads are planned to be shown here.
Category pages: Generally the second most performant page type, integrating both category and search allows Criteo to see a more full-funnel user journey to help our algorithm learn and is essential even if no ads are planned to be shown here.
Add-to-cart events: This is essential if your ecommerce platform allows users to add products to their cart without needing to open the product detail page. This improves the keyword model for your account and allows you to build an audience for products that are added to the basket.
Product detail pages: Is essential for building the keyword model. It is also used to update prices and availability in real time for products, without this there is a possibility that we could return out of stock products in our ad responses. If you are relying solely on the product data sent by the API to show your ads, without real-time product data checks. Implement this event even if no ads are planned to be shown here.
Transaction pages: Crucial for tracking attribution, without this the integration will not work.
Homepage: Often has the most impressions, useful for campaigns with post-view attribution.
Checkout pages: Used to decide recommended products based on cart contents.

API Endpoints

Criteo’s Retail Media ad delivery system offers three distinct endpoints, each tailored to specific regions. These endpoints ensure that the closest data center is utilized based on the location of your servers.

Endpoint Structure

Host: d.[region].criteo.com
- Supported regions:
  - EMEA: eu
  - AMERICAS: us
  - APAC: as
Path: /delivery/retailmedia
Scheme: Always https
Query Parameters: Described in [API Parameters](doc:api-parameters-1

Possible Endpoints

EMEA: https://d.eu.criteo.com/delivery/retailmedia?[parameters]
AMERICAS: https://d.us.criteo.com/delivery/retailmedia?[parameters]
APAC: https://d.as.criteo.com/delivery/retailmedia?[parameters]

Usage Guidelines

Use the endpoint based on where your API calls will originate, not where your users or your frontend are located.
If you are unsure of which endpoint to use, please ask your technical account manager for guidance.