Brand pages support impression, click, and add to cart metrics per segment. You are able to use the brand page reporting endpoint to synchronise these events in a single push update, or multiple as the customer loads and browses the page.

🚧

Standalone event reporting endpoint

The brand pages product operates on a standalone endpoint. Reporting impressions and clicks for core ad serving platform events will not work through this endpoint. Only brand page events can be recorded.

Reporting events

Events can be reported to the /v1/bp/events endpoint. Supported values are IMPRESSION, CLICK and ADD_TO_CART. And other value types will be ignored. An example is provided below:

POST $BASE_URL/v1/bp/events HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: <Bearer_Token>
retailer: Retailer name
{
    "sessionId": "5cat7-9964-4l",
    "brandPageId": "33c69835-cabb-4a1c-9f44-8b74089f60a0",
    "serveId" : "59e655b0-bd3a-47bf-958b-dffr-3433-2450",
    "teamName": "your_retailer_team",
    "events": [ 
      {
        "eventType": "CLICK",
        "widgetId": "c10f1a33-4d7e-4d4a-a5b6-f5146aca434f"
      },
      {
        "eventType": "ADD_TO_CART",
        "productCode": "111223"
      },
      {
        "eventType": "IMPRESSION",
        "productCode": "111221"         
      },
      {
        "eventType": "IMPRESSION",
        "productCode": "111222"         
      }
    ]
}

Events can be batched in the events array of objects. Each event represents an impression, click, or add to cart on a segment or product.

You are able to view a description of each field in the Reference.