GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Events - Interactions

Use this reference to interpret interaction-related events provided using the Experiences SDK onEventTriggered callback. It lists the interaction event structure and explains each event_action and its associated values.

Events have the structure outlined in the table that follows.

Table structure

  • Field: The field name.
  • Field data: For fields with a variant type, this column specifies the name of the field data within the variant
  • Type: The type of the field or field data (if the field is a variant). Possible types include Number, Varchar, or Boolean.
  • Example: A sample value or instance of the field.
  • Description: An explanation of the field's meaning, if necessary.
  • From version: The SDK version from which this field started being reported.
  • web/mobile: Indicates whether the field reports data only when a viewer is on web ("web"), mobile ("mobile"), or both (no entry).
  • Options: Lists possible values for the field if it has a finite set of options.

Interaction events

FieldField dataTypeExampleDescriptionFrom versionweb/mobileOptions
Interaction (Variant)interaction_idVarchar65957ba84f3459a17f1fdd1a
Interaction (Variant)interaction_textVarchar{ " question " : " 🤔 " , " answers " : [ { " id " : " 65cfd9ab600e4a7532c41a1d " , " image " :null, " text " : " Moises Henriques " , " isCorrect " :true}
Interaction (Variant)interaction_typeVarcharPoll"", Quiz, null, Poll
Interaction (Variant)interaction_selected_answerVarchar65957ba84f3459a17f1fdd19The answer that the user choose
Interaction (Variant)content_session_idVarchar70f4bbba-d237-4cde-b2bf-068473d46976same value as the stories/moments session
Interaction (Variant)content_idVarchar664df23eb615f6b5a13e44edstory_id/moment_id
Interaction (Variant)content_typeVarcharMomentnull, Story, story, Moment
Interaction (Variant)content_titleVarcharLoïc Badé with a Spectacular Defensive Act vs. Athletic Club
Interaction (Variant)content_page_idVarchar6554d01e182ca9d8338dd101
Interaction (Variant)content_extra_infoVarcharnullnull
Interaction (Variant)audio_stateVarcharMuteIndicates whether the user viewed the interaction with or without soundnull, Unmute, Mute
Interaction (Variant)playback_action_methodVarcharPressnull, Press, Release

In the table below, you'll find descriptions for each event_action, along with indicators showing whether the event_action reports a specific field (fields from the Interaction variant only).

  • Note, that each event_action reports not only the fields listed in the table below, but also all generic fields, as described on the events page.

event_actioninteraction_viewinteraction_answeraudioshare_clickplayback_pauseplayback_play
DescriptionThis event will triggered when the user viewed the ad contentThis event will triggered when the user clicked on the ad contentsame logic as Storiessame logic as Storiessame logic as Storiessame logic as Stories
content_session_idVVVVVV
content_typeVVVVVV
content_idVVVVVV
content_titleVVVVVV
content_page_idVVVVVV
interaction_idVVVVVV
interaction_typeVVVVVV
interaction_textVVVVVV
interaction_selected_answerVVVVVV
playback_action_methodVVVVVV
audio_stateVVVVVV

Did this page help you?