NOTE
To add Embedded Messaging to your Iterable account, talk to your customer success manager.
In this article
Permissions
To work with Messaging Insights in Iterable, you'll need various permissions:
Action | Required permission |
---|---|
View Messaging Insights | View Reports |
Save views in Messaging Insights | Create and Manage Reports |
Campaign Analytics and Messaging Insights
To monitor the results of your embedded message campaigns, use Campaign Analytics and Messaging Insights.
For example, here are some embedded message–related metrics displayed in Campaign Analytics:
In Messaging Insights, when filtering for embedded message–related events, make sure to set the Type filter to Eligibility (since Embedded Messaging does not user blast or triggered campaigns), and to select the Embedded Messaging–related metrics:
Events and metrics
As users interact with your embedded message campaigns, you can track various kinds of Embedded Messaging–related events, examples of which are shown below.
These events are the basis for the Embedded Messaging–related metrics described in Metric Definitions, which you can view in Campaign Analytics and Messaging Insights.
TIP
For any given user, you can view these events in Iterable by navigating to
Audience > User Lookup and pulling up their user profile. Or, you can query
a user's events by calling GET /api/events/{email}
embeddedClick
events
{ "deviceInfo": { "deviceId": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36", "platform": "Web", "appPackageName": "com.example.app" }, "email": "user@example.com", "templateId": 13137427, "messageId": "dXNlckBleGFtcGxlLmNvbS8xMjM0LzExMTEyMjIvMzMzNDQ0NTU1L2ZhbHNlCg==", "createdAt": "2024-06-17 19:30:51 +00:00", "embeddedButtonId": "", "campaignId": 9950575, "embeddedTargetUrl": null, "itblInternal": { "documentCreatedAt": "2024-06-17 19:30:51 +00:00", "documentUpdatedAt": "2024-06-17 19:30:51 +00:00" }, "eventType": "embeddedClick" }
embeddedImpression
events
{ "embeddedImpressionDisplayDuration": 12.625, "deviceInfo": { "deviceId": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36", "platform": "Web", "appPackageName": "com.example.app" }, "email": "user@example.com", "embeddedImpressionDisplayCount": 1, "embeddedSessionId": "fc159ed9-05f7-45f1-9eae-47b21847b7f5", "messageId": "dXNlckBleGFtcGxlLmNvbS8xMjM0LzExMTEyMjIvMzMzNDQ0NTU1L2ZhbHNlCg==", "createdAt": "2024-06-17 19:31:00 +00:00", "campaignId": 9950575, "itblInternal": { "documentCreatedAt": "2024-06-17 19:31:00 +00:00", "documentUpdatedAt": "2024-06-17 19:31:00 +00:00" }, "embeddedImpressionPlacementId": 484, "templateId": 13137427, "eventType": "embeddedImpression" }
NOTE
An embeddedImpression
event represents the number of times a given embedded
message was visible during the session, and the total amount of time the message
was visible (in seconds) across all those appearances.
embeddedReceived
events
{ "deviceInfo": { "deviceId": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36", "platform": "Web", "appPackageName": "com.example.app" }, "email": "user@example.com", "templateId": 13137427, "messageId": "dXNlckBleGFtcGxlLmNvbS8xMjM0LzExMTEyMjIvMzMzNDQ0NTU1L2ZhbHNlCg==", "createdAt": "2024-06-17 19:30:33 +00:00", "campaignId": 9950575, "itblInternal": { "documentCreatedAt": "2024-06-17 19:30:33 +00:00", "documentUpdatedAt": "2024-06-17 19:30:33 +00:00" }, "eventType": "embeddedReceived" }
NOTE
An embeddedReceived
event indicates that a device has retrieved a message. It
does not mean that the message has been displayed.
embeddedSession
events
{ "deviceInfo": { "deviceId": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36", "platform": "Web", "appPackageName": "com.example.app" }, "email": "user@example.com", "embeddedSessionEndTime": 1718652660218, "embeddedSessionStartTime": 1718652647592, "embeddedSessionId": "fc159ed9-05f7-45f1-9eae-47b21847b7f5", "createdAt": "2024-06-17 19:31:00 +00:00", "itblInternal": { "documentCreatedAt": "2024-06-17 19:31:00 +00:00", "documentUpdatedAt": "2024-06-17 19:31:00 +00:00" }, "eventType": "embeddedSession" }
Want to learn more?
To learn more about evaluating the performance of your Iterable campaigns, read: