How to utilize event streams to capture in-app message metrics
event.kind
of In-App Message Events:
message.iam.impression
message.iam.clicked
message.iam.page_displayed
event.data.page_name
and event.data.page_id
.
event.data.target_name
and event.data.target_id
, as well as the page the target belongs to using event.data.page_name
and event.data.page_id
.
See In-app click actions for details.
event.data.page_name
and event.data.page_id
. The impression for the first card is fired as soon as the document finishes loading. Subsequent page impressions are fired upon swipe.
event.kind
can have additional event data depending on how you create the in-app message.
event.kind
is clicked
or page_displayed
. Not available for impression
events.The page_name
is helpful to know which page was displayed and what was clicked on that page.Page names default to “Card 1”, “Card 2”, etc. but you can change the names within the Block Editor.page_name
and target_name
values in the event stream until the In-App is updated with custom names for each page or block.
After the In-App has been updated, event stream requests that are triggered from that moment on will have access to those values. At any given time, the page_name
and target_name
values will reflect the custom names state of the In-App at that moment, which may change if the In-App is ever updated again.
message.id
, page_id
, and target_id
to validate uniqueness. Custom names can be used but are meant to help differentiate between elements in one IAM in a human-readable format. If you have multiple in-app messages, use message.id
to differentiate them.