This document explains how to report impressions and clicks using Epsilon Retail Media APIs, with steps for integration and improved ad ID validation.
You will need to get your Base URL from Project Agora Commerce before you are able to report impressions and clicks to CitrusAd.
Reporting clicks and impressions can take up to one hour on our staging environment. This is not reflective of production speed and should not be regarded as such.
To effectively report impressions and clicks, use /resource/ endpoint. Impressions should be directed to the first-i resource, while clicks should be reported to the second-c resource.
Prerequisite
Obtain your Base URL from your Technical Account Manager before reporting impressions and clicks.
Integrating Endpoint Calls
Endpoint calls must be executed within your app or website. In Project Agora E-Commerce, the integration process is similar for both mobile apps and websites due to its 'backend to backend' integration approach. This approach ensures that ad requests are consistent across both desktop and mobile platforms. However, since mobile apps do not support JS libraries, you must make backend requests to our click and impression endpoints.
Reporting Impressions
To report an impression, send a GET request in the following format:
To report a click, send a GET request in the format below:
Replace AD_ID with the adId provided for the ad you are reporting.
For example, the following GET request reports an impression for the adId, display_xw3ybbrymHT_D3VwU3Ic5ThUkbhFNkY4NVNIODU4NEVGRkdT.
API Validation for Realized Ad IDs
The API includes validation for ad IDs to ensure accurate data and reduce errors. Requests with improperly encoded or prefixed ad IDs return a 400 error and a detailed error message.
