This document outlines the new methods available in the MoEngage iOS SDK to report impressions and clicks for experiences fetched using the MoEngage Personalize API. These methods are currently available only for the iOS SDK.
Prerequisites
SDK version
You must update your Native iOS SDK version to 10.01.0 or higher.
MoEngage Account Configuration
Ensure your MoEngage workspace is enabled to utilize the Personalize API. Refer to this article for details on setting up Personalize API experiences.
Reporting Experience Shown events
The SDK provides helper APIs to track shown events, refer the API documentation for more details.
Impressions should be reported when an experience is visually presented to the user.
Single Experience
To report an impression for a single experience, pass experienceContext of the experience as a map.
experienceContext is a JSON object that is returned as part of the response of the Personalize API request.
Mulitple Experiences
To track the experience shown event for multiple experiences use, pass the list of experienceContext of each experience as a map.
Reporting Experience Clicked events
The SDK provides helper APIs to track clicked events, refer the API documentation for more details.
Clicked events should be reported when a user clicks on any element that has been personalized using the response of the Personalize API.
- When you call
experienceClicked(), the experienceAttribute dictionary must contain both cid and experience keys. If any key is missing, or the call is made against an un-initialized Workspace ID, the SDK throws a fatal exception and crashes the app in DEBUG builds. In Release and TestFlight builds, the click event is dropped silently and logged.
- If you are upgrading an existing app and these strict
DEBUG validations cause disruptive crashes while you refactor your tracking code, you can temporarily opt out by calling disableIntegrationValidator() during SDK initialization. Use this strictly as a stopgap for phased upgrades, and aim to remove the opt-out once your attribute call sites are properly validated.
Single Experience
To report a click event for a single experience, pass the experienceContext of the experience as a map.
Multiple Experiences
To track the experience shown event for multiple experiences use, pass the array of experienceContext of each experience as a map.
You can optionally include a b_id key in the experienceContext object to provide additional context about the click. Its value should describe the specific component or interaction within the experience that was clicked. This is particularly useful for experiences composed of multiple interactive elements, helping to distinguish between clicks on different parts of the same overall experience. 
