Definition

The homepage is the initial landing page of the website.

When making API calls for the homepage, the parameters described below should be used.

Parameters

`event-type`

Value: viewHome

Description: Indicates to the API that this is a homepage request.

Required: Yes

`page-id`

Description: An identifier that tells Criteo which placements to return for the ad request. Placements are instantiated by your Technical Account Manager depending on your desired ad configuration. Below are the standard page-ids for this page type:

In Americas: Typically follows the structure [event-type]_API_[environment], e.g., viewHome_API_desktop, viewHome_API_mobile, viewHome_API_android, viewHome_API_iOS.
In EMEA: Typically follows the structure [event-type]Api[environment], e.g., viewHomeApiDesktop, viewHomeApiMobile, viewHomeApiAios, viewHomeApiAa.

Required: Yes

Sample calls

📘
The header values in the sample calls are illustrative. Make sure to replace them with the appropriate values for your implementation.

AMER

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=12345" \
--data-urlencode "environment=d" \
--data-urlencode "retailer-visitor-id=a1b2c3d4e5" \
--data-urlencode "customer-id=123456789" \
--data-urlencode "page-id=viewHome_API_desktop" \
--data-urlencode "event-type=viewHome" \
-H "Referer: https://www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

EMEA

curl -X GET "https://d.eu.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=12345" \
--data-urlencode "environment=d" \
--data-urlencode "retailer-visitor-id=a1b2c3d4e5" \
--data-urlencode "customer-id=123456789" \
--data-urlencode "page-id=viewHomeApiAios" \
--data-urlencode "event-type=viewHome" \
-H "Referer: https://www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: app_ios 1.2.3"

Mock retailer API response

The API call below will return a response for a mock retailer.

curl -X GET "https://d.eu.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=108341" \
--data-urlencode "retailer-visitor-id=456" \
--data-urlencode "customer-id=789" \
--data-urlencode "page-id=viewHomeApiDesktop" \
--data-urlencode "event-type=viewHome" \
-H "Referer: https://www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

🔗
You can see an example of the response here.