Tracking Engagement with Campaigns

For the request structure and examples, see the API Reference: Track Engagement

Engagement is a measurement of user interaction with your experience variations, typically by clicking items on the page, though you can also measure impressions. These metrics enable you to analyze the success of your campaigns, and improve performance.

Make sure to implement all relevant engagement types for each campaign, as follows:

Types of engagement

• IMP: Reports variation impressions. Pass the same parameters as are required for CLICK engagement. Important note: Choose calls report variation impressions by default. Report impression engagement explicitly only if you set the implicit impression to false in the Choose call (isImplicitImpressionMode = false). See the API reference for Choose calls (under "options").
• CLICK: Reports when users click a displayed variation of a custom API campaign or the widget of a recommendation campaign. For example, the arrows or pagination of the widget. To report the click, pass the unique decisionId value, from the Choose call response.
  When you report engagement for multi-variation campaigns, pass the variation ID of the clicked variation, from the Choose call response.You can also report CLICK engagements for control variations of recommendation campaigns, using decisionId.

Note: Be sure to report engagement for all variations, including the control served from your codebase.
If you don't, and you use CLICK engagement (click-through rate) as a primary test metric, the control will appear to have no data—invalidating your test results.

• SLOT_CLICK: Used in Experience Search, Recommendations, and Sorting Optimizer campaigns. Reports which product was clicked, enabling detailed analytics by category, product, and strategy. To report any engagement tied to a product—such as Product Click, Add to Cart, or Add to Wishlist—include the unique slotId returned in the Choose call response.
• SLOT_IMP: Used in Recommendation campaigns for Restaurant sections. It tracks which product was presented. Pass the unique slotId for each product from the Choose call response.
• PN_CLICK: Used in Reconnect push notification campaigns only. Reports clicks on the notification. Must include thetrackingData object, which you must extract from the messaging provider. The object is always unique to the notification, and looks like this:

{
    "type": "PN_CLICK",
    "trackingData": {
        "rri": "987001424",
        "sectionID": "9878785",
        "reqTs": "1652622484055",
        "userID": "4656722918296846673",
        "version": "2",
        "events": [{
            "ver": "101482916",
            "expVisitId": "4032971100745578591",
            "smech": "",
            "vars": "[101098971]",
            "exp": "1296028",
            "mech": "1"
        }]
    }
}