For the request structure and examples, see the API Reference: Reporting 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.
You can set CLICK engagement (click-through rate, or CTR) as a primary metric in your testing. If you do, make sure to report engagement for the control variation as well, so that the data is included in the relevant reports.
Note the difference between engagement and events
While engagement measures direct user interaction directly with a campaign variation, such as clicking a banner or a product in a recommendations widget, events are other defined user actions that aren't necessarily related to any specific campaign, such as purchases, logins, making a deposit, watching a video, and so on. Learn more about Reporting Events via Server-side API.
Types of engagement
- 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.
- 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").
- SLOT_CLICK: In Recommendations campaigns, reports exactly which product was clicked within a recommendations widget. This enables in-depth analytics for recommendations beyond the campaign level, reaching even the granularity of specific categories, products, strategies, and more. Pass the unique slotId for each product, from the Choose call response.