Events

Create an event used to record user actions

Report what the shopper saw and did with the offers returned by /recommendations. Send the session_id from the recommendations response with every event. The event_name values, what triggers each one and how often to send it:

Event nameDescriptionFrequency
WIDGET_LOADTriggered when the ad unit (widget) displaying Disco-powered recommendations successfully loads into the UIOnce per session
WIDGET_DISPLAYTriggered when the widget is visible within the viewport (even if partially)Once per session
WIDGET_VIEWTriggered when the widget is visible within the viewport and meets IAB viewability standards (at least 50% in view for a minimum of 1 second)Once per session
BRAND_DISPLAYTriggered when a specific brand/offer is visible within the viewport (even if partially)Once per every advertiser
BRAND_VIEWTriggered when a specific brand/offer is visible within the viewport and meets IAB viewability standards (at least 50% in view for a minimum of 1 second)Once per every advertiser
BRAND_CLICKTriggered when the user clicks on a specific brand/offer
PRODUCT_DISPLAYTriggered when a specific product is visible within the viewport (even if partially)Once per every product
PRODUCT_VIEWTriggered when a specific product is visible within the viewport and meets IAB viewability standards (at least 50% in view for a minimum of 1 second)Once per every product
PRODUCT_CLICKTriggered when the user clicks on a specific product
ELEMENT_CLICKTriggered when the user clicks on a non-significant element, such as: skipping an offer button, the privacy policy link, etc.
post/events

Request

Headers

versionstring required

The version of the api you wish to use

Request body

OR
OR
OR

Example request

{
  "event_datetime": "2025-03-21T17:32:28Z",
  "session_id": "70f05c32-7760-4753-93c9-b759cf7e7fda"
}

Response

The request was successful, and a new resource was created.

Changes

No recorded changes to this operation across all 1 revision of this API.