Beacon types
This page breaks down the different types and levels of Criteo beacons
Here is an example of an API response returning a Commerce Display ad unit:
{
"status": "OK",
"onLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=sdfn829dJSHcuis_fSDJKF78wHZ_SVwv_cfy0nSfkSFHFffYs65nds6nvdshf3Rs5_fdFRGzlWsjGIawBFDQswMswBhq7yK14eKmK4cNZAPnq0etO07G-53EGqVKmlCUIqFt_HLAE2h0KJZSn_d4ozkI900RUgu-L-97OWqk_mrnkpvN-eFxXG8CM19U4n4S1QChcpDyMg1_qrbjK8lvNsCyAYioy8D-YBwHbXlMDcljf1B7Vx9-pyh4m9CMuWDuVLOcjtZ3fJ3ls9_j1bD1eEG41oHOq4dO6DS3HuTaLRTPVDHkFP8ck_WxJYyo7OSO98AB98AqM1Ra_WG9WTeJ8xTVLxBu5hF9yVdBjnZbXAyhF88_Ktm0B74rTMkB7qkHBLRvsaZh2UTESdH7nD_wP2wnjVO-McJ0mDQUFiBUzPOljik0OJA61fsKSTES4AvHr4VEVdYMZSA09obJWFwbCUMweFhLdURgHrtHOXqSXbqXTZBDx1jGocZHEwqD5nsJMdqebDg0_CEg8HBqoCZLfQI6Yfw&ev=4", //Page-level load/impression beacon
"placements": [
{
"viewHome_API_desktop-Flagship": [
{
"format": "FS",
"products": [
{
"ProductId": "16823",
"ParentSKU": "16823",
"OnLoadBeacon": "",
"OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=s4MUgb0p2qiOW6OXiDQ9tl3s-sHHnt2WXqEoCFO8R3FKGSf3dJWtjvWJEO7oKG19T75RS1_tbsMbbQCZmgXk29dnbhUX1BJOFSzGWXdpHb3Cvj_qbatHmoLwpWIpki6xbLOPpdjwesx9gx3WSrajV0KwNtGRCWlILLZMBTSBiBzXrbnR0pmTkyJwdxHN-xR70VuGcOCWXcoDxFcgXs2x7mjF7Bwo8Rv7ncoIDJuh1rSGX_eUE_2fu5s1COjtAtjOF9IpByRHiUzfTBkOoLLNMlCo6CrLo3cksFuFvJ93xiMx3oGp2g-WPejLjeIlBuYP_3Ps6tkScZNxUz1I8YwSqgeLWUmvyV0DnAKZH-JcXGhn7Rd2R2FClEFuXoBYtrFj1LTlhf_q9_KMBgQ3NvH4uQ&ev=4", //Product-level view beacon
"OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=IZWg4EkEK2twk5A7D_FAZVTkQxrW_ZFxNplIQ6Bmm5D_XAvAlG6HlVf-rJGM0cc20c_yhL-uslQy9FlYrfiD-U7iN0q9ldQKcxiKGu36ld2oFSR3uS87hWKeOz27ZMUChe8wack-2c0_zcRnyKhzmD-T0E-87RgHDBMNewjwnbNQLbjRpI7Ho6ox7Hsjp4Pb389yx3uDTNJ4rX8P_K3IhmgVpqCUH_h7DmntcCIATWySeiJECSBIizJ_MUSyzDdb88Fbj0frlauQ5J6vjhO32igX_HmfCtolAOuKVTQMJK5z4C_ZWlEDtXNR2rYdC6nCMBYh7gcbR-XQJZBsn3K9slOS67lQJ5Y8LsCtuAyxqPkonbjuF7vKMQdqXI-ukbuscGoVFz030rvZbabkjs6AQQ&ev=4", //Product-level click beacon
"OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=84B7sn1OYECasc1VjXL4JFN1RFip8yb42Dt90z7yfYSFQ5cKQhvDw9-KEFdvsSrmaZbxrW24g1xK24fQDXRm5vqlRpQ84UbJ1Voua3k3K0DhhlpLvUZf8MCcY7G8R4J-8l1Thhy9vAgaQ9Reh2l_pKtn0G9yobBXdzdG5b_ZM6CuF7a4c2fwvZoo-oFtZisOQq2yw2D0O0leQYlofB74IsGCoo_x2vpUL5xlPtA4GvBK9LURx9waJZ9bSC1VScEd5yJDPGw0cAGHlZJ67IwybQTi36v23TGej0cEimkaEAZeE6HsR4a-w1ALeVFzNl_uaHwDYx9pqhG3vIHzwbBG8nbBy8gQTI7fLA6NZBZMmLchZBW2ZBv8PzkkndgxAP5_RWZNYRp8HSdqHnL6vM9j0A&ev=4", //Product-level click beacon (for add-to-cart-click)
"OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=p-qo5UOTqS4wf7Xr1RzsVOdHHhtWkTjtnyS7LFTEVS7gzTgX1yp4AkZzq4ABrxS_-n3CvbV7MEflqu8jW7lHyftktBXZj4736aIGbBvQQK8zss9Pcvb44_tuPWaUO6K6XxEGo72DhlU9SVxL5ggENsS5x8RcRVxL20B4na9cJrbZ_PGXyVyBLrdmmkdn29ToWhDWpdSxA0op5nk8c9UU0IVgpWC3ZOepgB2toTH9AyIZi1zcwxEutGpQ2ptLrS0hVSyVxPWIWFsLr6F49fWje0rB-klFEjPjPj6D9zMgdT3I89UQL8Jaim0q_C_vqgOO3FG5ecwigCvS-j3kDWEThDlOVYg9QTUlupSrtP9T3K1Zdl0I4RQeP2s5oF9L7GdvX73_K7Zeb_5DZqCOEpfFqw&ev=4" //Product-level click beacon (for add-to-wishlist click)
},
{
"ProductId": "19494",
"ParentSKU": "19494",
"OnLoadBeacon": "",
"OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=y5-OVUh7SAs63ua-tXWrE-hKBle8TbRjb7ITYuhBBqSTmkBxrXnxnPmHXVAby_gDc5aCqM3rF66tJY5CzFAxdIPOU9hujzb22R6nC5s4BNOmZHySBOwv-Omfsj02E1_vyAmov2TmeZofRM_ixmc7Gb-9vnD-Nya8Jus1kOLcoMF_wSDrMSlHxOpm6-fnqVEpEgnPkW4gPokouZC-bL-UPKxQM8SxsNCeaJimBcu2Pund-1SkkkK95O-qq4kboHjwnfmIijOHtFe0Xfsjsqscxy2Akz860toeZn-KISs8YBrOJBUdm82c1bHrZ5LB7NPR1iDOtzwe2ef_at96hCHoyrh-4e0v2o2jGqaoUG-E_ITG_Z2j01xs00dMqyKoPn4VEp7AzvO_ogH3sosgrBwnBg&ev=4",
"OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=GR3fsa56mrEr8_rFee3jXYX46r69EHtPMAhvltFZM3TrjpzouRWR4ZOgWCegEKcH0C-wfg7JBqJEpDoxsTpPhvlm7stXwjqYgSItt95pkeuie8YEqLgGJGBeY-ljC8sO4JKbMjtY3eMrR8Esw7zM1paZGzYUpple4AAfTdbT1L03tLKgfz4dFcGO9_Q91smQvneqseV8qmUjcbkroMcC8-0NNPWRzPT6QnucQlsBZuiFgDvTrpUrvbwgS41hh8KW1anp5FFqFHyL2jSM0lH0lHahdo4hxxJyWOoIceGSNfGE0-nwMHmvmqeqszbmgrMfz_C5fpSsa_M8fOVBg-7g3iZcGTFDZ33WgTQnqt7VCfV1xRwUVvBSrg3klW0wgeNDrSuEJzCtlkv8pV3pupD2-Q&ev=4",
"OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=Bvr2njkxIMlNUUbyH6ubRMJqIgw6p7mQjYr7z3tr3W1elo-OkTojl7W6yJUkRb14EiWFtJG8Jo8OeUhy-ArRym5HceeaM-vRFpFOv7weYyYe565sLG5bQBdZhXHJASWBVXobBZ4PCxniZVp-JNpCB2aU-btujaeNfeayNwtHpV24p-SkxauLgOXRy_FIlSjmZkJkGIRukzRMwxWKh55W43LxVr-2uVtOqq6Tg8QLJOneRks0noLnlOST-l2hHMJxJqK-AModUnuY5T8sn3s6x6epRtRMfDoi5MOkJooju16qurFbT6qyGNFSb_hMf82IfdA86pjRpeWJ9DBC3UAZF_bhgTZVjnX1qwHVF_GR3i-kRbNHt30BvZFMJwjO09BqMVx8bZKZaOR5iHMbHIkogA&ev=4",
"OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=jMoh1dvUxY5LlNEdfXlGZmXRCxi5QSVhFfgptMG1pGyeAYbZ2jvsYVhDqTrFvbLIM7kHi2y1RHXzmNPfHvZifBQpW9sh26BRsuVLdljLruxfxZT_Wtyi4D1KcCA3A09vz4mCIm1MuzHlXTPN-y7oTJqPajjzkeSJSDQFbX-hYEANVbIKhjPET7udRb8R34MtYZQFuqgOuWpCXqPh0JdQSDX9DuLewmI3ZfznR9IeWAwCPMZjiVAZ8KPR6Gy-SsaoLumggq-ikAj3svtK419b47u2ukbW_5S4pZeaq8glbE6nNLpUQdt5k9Drp9echMVY2Y6YkYlvHipFlLqdmrEjKYQ6_oEVVIooxSUt97nUfeQE653nmSN9RlHDfCw8AaaEjaiINAd82jyoMbOD9BezBg&ev=4"
},
{
"ProductId": "15742",
"ParentSKU": "15742",
"OnLoadBeacon": "",
"OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=nA2BvAMRGhTnq4v2AWuk3BNlPZna1pHKObORJAkN7oW6vUC_e70WtzBFKV40CyiVAX_Dl8i38Bouu9GWQambqmxwZDQgcrWgHE7AOTGMr229QTu9ZpkAAJiuvLLgLp1BdieXDoQUH7Mr5tj_JNcD8ufIW3V6qBEXsg_FB8rzmTbwaQ8Pzx5E0ukEYUUqVHBZmqS7jZqo0jfmihYR9X6U0_ayKed1mps5qHH8k9MeF6T_bMCZt7aN9ipLLPxRPOmgt-852ZDiaixUr-f0qFxFs9XobID5y5mO7TJX2dKjQjVyTeoxSfXkjdQN8JX5SYwuDtl_8k4qExzr6zZ1oL5acfimqVPrixtdBWP3DKILdDwumWp31ZdPxTq9JPbNUyE919WZLeoblsCk8Kcp5t2eYw&ev=4",
"OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=NhGtK-T_dijg2M8c4LyLStkPbVv7l1C525iJEsTLvLaooegslXLpxbwPoIeWSfy9U2Re1Zd-l_K8UjsfBvHe6aizQ7UQsZ562DLuXGFebWcMflPhmLZ3Fy_LIH1plFbg9KmOYHhCDyeioUvBdZhqZSOeYper5LOOKP57Ld4QMh-fCtWzv0ScZpM8oWMDJMVLTF1SuT2bLFs9ZRfmNCNnu6obAecVxvv31Iod7010gme-pnvA4gImYh1rCIVZ95ISx0FmjVVw-Im5fVbjgKF2p4m8q-DPM8cpS_LvS6stnoOPi2DLDb-TM07sS4GyzB0KGIfKkMeaVBOSNvTYY4JeSJ6qGASrd2osYVFgW3l1jfB7oqkyPpRjkTCh-V4gc7xjPD01sNmqL9BOM9-jWrOO3Q&ev=4",
"OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=65vo05e5FJF5RdRTgEI508JGOmZzDY2210JZqqjV1L20AgkC6dXSadUc6VrIOpxvs0_kzeBSNfJgwKlRoiqbuBGWKIAFnfLm3d5vSzefbV_ZSddTOsb-ZX6yNf8oxxo2EIur4BM_nu8Mu_eh4UsLK1Mq1AeEmvQ6ZJEDf9Yz4l2ouG2JrQf2NW-lyO5SI9vyKuA3SNx2S2Sf_pRP4cbGuGpfRQXxHLV_K1VXoMpJW9reKlzQv8_u7A6XdEgyX3GwVM4AITNMA6PbNsKKQdTER3ywdDyydPiAdA7jg9UOMP098RYzYi43XZPpLbLyOxvaqdKVLYyq8UBME6E6Wr7eC267SQiJn8r-jqffU6iUfH4WgUMRtOQwfbx0hGH4yJJu8y0v5JAxwxAld5VwEfP30Q&ev=4",
"OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=RbrsRpZFm59CHAoMg0iamPzWIAOB-61izO9f1XjyUSq5GuyvZLEhy1sc7r9qWO1WWT-eZIgPp46p6J56FEodBIbdnKL844tC0f-i3pKSz26rsL1kIepzVOtAMgm_1UCCc1q2iFXeRSIPmgS1IejfR6ToEtRgylUhxjJWBEAzA1wOtSFAbOX6j3YbtqjLMRsaxgKdvSPC2h_agZ8v5JoC5zpL70crF5JhLdojd42VCzv9STkVcISbDvCovbveL92KA_GfB-NDt4mIN8_NHHZeM2_szqLeVdbv82A759STYaSZD0AzA4OFcYnGtBYplYgxK8pqgJMYPZ9yob_las_A9AHE-AUkJYKoRZDvlETUHon0p8TlYQXkpDqnVP_maU6BIpUMmmfe5NJzdwk9pSrPJQ&ev=4"
}
],
"products_order": [
{
"products": [
"16823"
],
"isMandatory": false
},
{
"products": [
"19494"
],
"isMandatory": false
},
{
"products": [
"15742"
],
"isMandatory": false
}
],
"rendering": {
"desktop_background_image": "//retailmedia-static.azureedge.net/creativeassets-live/d6bfdeefc36e382e53befaeed8d1dc53f07110131a75b275c48fdbf279f4e853.jpg",
"desktop_background_image_alt_text": "",
"mobile_background_image": "//retailmedia-static.azureedge.net/creativeassets-live/71a4499cd0f16fe4f1ecd475b7b90e63188f45b212e1cce3bd1aae5a148e34d9.jpg",
"mobile_background_image_alt_text": "",
"optional_footer_type": "file",
"optional_footer_redirect_url": "www.criteo.com",
"optional_footer_redirect_target": "_blank",
"optional_footer_redirect_url_app": "www.criteo.com",
"optional_footer_media_file": "//retailmedia-static.azureedge.net/creativeassets-live/4ba277a9762360ac4ca6f933d522da5bfb7a7937c3491e3887291e994e512005.pdf",
"border_color": "#CCCCCC"
},
"OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=kwp2GQrVizyjE_f5R4AKDxHZ_SVwv_cfy0nnuxGkZI4uv3YzfiEKFcBm3Rs5_fdFRGzlWsjGIawBFDQDyMg1_qrbjK8lvNsCyAYioy8D-YBwHbXlMDcljf1B7Vx9-pyh4m9CMuWDuVLOcjtZ3fJ3ls9_j1bD1eEG41oHOq4dO6DS3HuTaLRTPVDHkFP8ck_WxJYyo7OSO98AB98AqM1Ra_WG9WTeJ8xTVLxBu5hF9yVdBjnZbXAyhF88_Ktm0B74rTMkB7qkHBLRvsaZh2UTESdH7nD_wP2wnjVO-McJ0mDQUFiBUzPOljik0OJA97OWqk_mrnkpvN-eFxXG8CM19U4n4S1QChcpDyMg1_qrbjK8lvNsCyAYioy8D-YBwHbXlMDcljf1B7Vx9-pyh4m9CMuWDuVLOcjtZ3fJ3ls9_j1bD1eEG41oHOq4dO6DS3HuTaLRTPVDHkFP61fsKSTES4AvHr4VEVdYMZSA09obJWFwbCUMweFhLdURgHrtHOXqSXbqXTZBDx1jGocZHEwqD5nsJMdqebDg0_CEg8HBqoCZLfQI6Yfw&ev=4", //Placement-level load/impression beacon
"OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=qrL1X0gCc0_99xluW-KXwEkCluMc7SLNbBgcDjm5todnq1SSYEcQOpthqyD69N3LbepzaFyoER1z3e7K0Y0Uv7c1fXuvlYMEkdn4Q-dx7wjkFHO_DsQwNSkSJTCk_6DKNjyksXYnzyKmuEP2AUuhfFeMPSfdtR_ogYx3YIxI4lej2XBnHXw7CH-6aS0UvfPItwL2CoTCwKmQIkQyRmp6PKCPe9di9n1YmlaQJ_o_y6MMwOC89kH6LYgNtWlIzkEa5NBzoAI41pgLJ5V1E4zqh6TKbWkQnHuEZWZE6HWtuxF7zj4zFfKXsWtOh8uGKiy-PkWbVS6n3ziq-x8Y6Z6bhbCs2DVu61eIsVLi9N-7lBwJvZRyk72tRHoSLQefIZ4teQsey0f8LoBixDIDvDFLMqtNT6UtF0kAdvVf1sGBnIGdYOskJmBpun_-5AxQ7JYYEKY8UgCuHRzuStz5kYAj6Q&ev=4", //Placement-level view beacon
"OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=SufwIvPHzAmyrws2Pgfyn0bOJ6OnniYbQfms_juqg1zhFOP8_X3Xpm1lZJC6O88f4c-jZg7RWVr4cYTOtb2-bZFwabzexJlZTOft3sHibcR0uMRdSzGrPpL0bl9zg6nH0zEo0BP_hVrLTgI8jNesN9RTeuEhSWdnKOcuO-p-rVwzyxmWlh-OmeQ_di2GrQsWIa8SOcnIiJnhTtDerJp4lYF3DHqA08xh0WqQO3y431Y0cAgYSFjQX-GCA57zd36gJ1C_-T2TlDtiaH0LA1vVJplIa6c3OgbDUJuJlSfW3947jn2gRHQMoDDxWyuTKR1A3QBKpSlxF9hpqc1FA6n_8Wk7_DOr001RLLVrnjSOmWPKLqkrFiu_BN9RR8rymj7bvV1wD2vXjrBY_hI8V-LiSQ&ev=4", //Placement-level click beacon (for clicks on the creative asset)
"OnFileClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=sloVjDHD68JAycBoAJGWQyFIP0DqMYoAFJSP31JQMX-u2zibhPNIgYJyzM8jtfZSVWvTguYgX_L1liSpZKPDs5IFswQ65p8x6fY7r4SqOXke00gRuROKj9aEPXRTHLYyKUHX8giA0ensbt3KM-v4qMvJZoOKVBv2_27zEAhrPt4Zz6V0Y4kRTqJRaXXvSY5IyDvm2Vj-yGYY1-es5XNN_4K5rAXRYZZJn0n9nOwXe17MepTt5MXMqwrhot37Fcjbu5ww_HkGvFQMTTB3MCgEnEnMcyxYzHUV3nC0jJr5X42-8ny3baUynPFUnuKwSfzSGQL5_5PoOr5aIZnnzzbLCMbbzcn1AgLbSpsskwxnxdtt9-TZ1IUfCGQpWw4cB0Eb7Kax5CWgZbvYj1__gqZkJvwK47N_ebBHVS9XuqWNVVY&ev=4", //Placement-level click beacon (for clicks leading to file download)
"OnBundleBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=6VUW1JJpcvC_2wJVOVs98zWwE58TE9NI_wWrdaOcnG6_HeWHFLog-1xP5F2v_zpXjCcrN6M7-PvXziHAb4BVZ5f7Tg7Rt-jhO7IkPhWVjrXE78djmHEhmgdUt9gFsFj4_4B_rYL5ZRa3QdlHns6BMntz39iElN0GnaTidmVd9aSWYM0Mw0DhT1DfvEisOsu4Dp87VFwJCRXqQB9J7tLlIEnf_m3KFvXdjImQ2x0yDUzAkVPwY_Ley-Vs3iSioioVl74xuW6rz9q2rDUCSC-B1TQETO3VmZd23H2BjrI5bF9IIShOiQG0SMtsYjHvFimInAJ9gmSbZLPi0QhopALOixXc79OJH7HbRv3DyF2ThXQX-A4F1dgXHjkk3IxY2fef803yG_Hdkbdw_UJ-rg__HQ&ev=4" //Placement-level click beacon (for clicks adding sets of products to basket)
}
]
}
],
"page-uid": "954ae0b4-c0c4-4898-9c18-bdd154eb9353"
}
Criteo beacons are categorized into three levels:
- Page
- Placement
- Product
Each level contains specific beacons designed for different tracking purposes. The following sections provide a detailed breakdown of each level, referencing the example API response outlined above.
Page-level beacons
OnLoadBeacon
OnLoadBeacon
- Description: This beacon is triggered automatically by the delivery service when the page loads. It only appears in the ad response when the parameter
nolog=1
is present in the API request, signifying it as a test call. Therefore, this beacon can be ignored.
Placement-level beacons
Placement-level beacons are associated with the entire ad placement and not with individual products. These beacons are part of each "placement" object in the API response.
OnLoadBeacon
OnLoadBeacon
- Description: URL to be called when the whole placement is loaded onto the page. For display ads, the placement is considered "loaded" when the entire unit is rendered. For sponsored products, the placement is considered "loaded" when at least one product is rendered.
Handling suppressed/non-rendered products
For SKUs that were not rendered, you must append additional parameters to the placement-level onLoadBeacon
to avoid inaccurate impression and attribution counts. Here’s how to handle non-rendered products:
- Specify non-rendered SKUs (mandatory): Append an exclusion parameter titled
&ex=
to the placement-levelonLoad
beacon with a pipe-separated list of the SKU IDs that did not make it onto the page. - Add exclusion reasons (highly recommended): Append a status code parameter titled
&st=
to the placement-levelonLoad
beacon with a pipe-separated list of status codes representing the reasons why each SKU in the exclusion list was suppressed. The full list of eligible status codes are outlined at the bottom of this page- Note: The number of SKUs in both the
&ex=
and&st=
lists must be equal and correspond exactly with one another. If no status code is available, default to a value of1
(generic catch-all status)
- Note: The number of SKUs in both the
- Example:
//b.us5.us.criteo.com/rm?rm_e=kwp2GQrVizyjE_....f5R4AKDxHZ_SVwv_cfy0nn&ex=SKU123|SKU456|SKU789&st=102|303|202
OnViewBeacon
OnViewBeacon
- Description: URL to be called when the placement is viewed according to IAB's viewable ad impression measurement guidelines. At least 50% of the placement must be in the user's viewport for at least 1 uninterrupted second.
OnClickBeacon
OnClickBeacon
- Description: URL to be called when the user clicks on the placement itself. Typically used for display ads when there is a click on the ad's image or CTA button.
- Note: These beacons are returned for display ads only
OnFileClickBeacon
OnFileClickBeacon
- Description: URL to be called when a click is made by the user on a CTA button, or from the creative image of the format, which leads to a file download.
- Note: These beacons are returned for display ads only
OnBundleBasketChangeBeacon
OnBundleBasketChangeBeacon
- Description: URL to be called when a click is made by the user on a button or image that changes the content of the cart/basket.
- Note: These beacons are returned for display ads only
Product-level beacons
Product-level beacons are tied to individual product tiles within a placement. These beacons are part of each product object in the "products" array.
OnViewBeacon
OnViewBeacon
- Description: URL to be called when the individual product tile is viewed according to IAB's viewable ad impression measurement guidelines. At least 50% of the product tile must be in the user's viewport for at least 1 uninterrupted second.
OnClickBeacon
OnClickBeacon
- Description: URL to be called when the individual product tile is clicked.
ProductPage
ProductPage
- Description: If the API verbosity parameter is set to
full
, the product object will include aProductPage
beacon URL, which logs a click event to Criteo's servers and redirects the shopper to the product's PDP. This URL can be used as thehref
value for sponsored products, enabling automatic click tracking without a separateOnClickBeacon
call.
OnBasketChangeBeacon
OnBasketChangeBeacon
- Description: URL to be called when a product is added to or removed from the basket/cart. You can add the quantity of products as a query string parameter. If no
quantity
parameter is provided, it defaults to1
.
OnWishlistBeacon
OnWishlistBeacon
- Description: URL to be called when the product is added to the wishlist/favorites.
Billable beacons
Billable events, tracked by Criteo beacons, include:
- For CPC units (Sponsored products):
ProductPage
- Product-level
OnClick
beacon - Product-level
OnBasketChange
beacon - Product-level
OnWishlist
beacon
- For CPM units (Display banners):
- Placement-level
onLoad
beacon - Note: This event can only take place once.
- Placement-level
Beacon duplication
All Criteo beacons should only ever be triggered once, except for product-level click events (
OnClick
,OnBasketChange
, andOnWishlist
), which can occur multiple times.Criteo automatically deduplicates all billable events. Therefore, each user action—such as adding a product to the wishlist, adding it to the cart, increasing the cart quantity, and clicking through to the product page—should trigger its respective click beacon for all click interactions.
Non-rendered product status codes
When specifying the reasons why products did not render, use the following status codes within the appended &st=
parameter on the placement-level onLoad
beacon:
Generic errors (0-99)
- 1: Generic error (catch-all)
- 2: Latency
- 3: AB Testing
- 4: Not viewable
- 5: Invalid Traffic
- 6: Placement/page not activated
- 7: Opted-out user / unknown user status
- 8: Not readable answer
Bid/Auction logic (100-199)
- 100: Bid/auction (catch-all)
- 101: Duplicate ad response
- 102: Minimum SKUs requirement
- 103: Placement already filled with other ads
- 104: Lost to competition
- 105: Bid too low
- 106: Blocked buyer
Creatives (200-299)
- 200: Creative generic (catch-all)
- 201: Not an advertisable brand (Brand Safety)
- 202: Not an advertisable SKU
- 203: Not an advertisable category
- 204: Wrong creative format (SP vs CD)
- 205: Wrong creative format (incorrect integration in retailer website, size, etc.)
Inventory/SKU (300-399)
- 300: Inventory (catch-all)
- 301: SKU not recognized
- 302: Not available in the user’s store
- 303: Item not in stock
- 304: SKU metadata not accurate
- 305: Missing info (price, description, brand, rating, discount)
Relevancy/UX constraints (400-499)
- 400: Relevancy (catch-all)
- 401: Branded search
- 402: Deduplication
- 403: Returned SKUs not in retailer recommended whitelist
- 404: Frequency capping
- 405: Relevancy requirements not satisfied
- 406: Geo constraints
Updated about 2 months ago