diff --git a/_docs/_contributing/homeward.md b/_docs/_contributing/home.md similarity index 100% rename from _docs/_contributing/homeward.md rename to _docs/_contributing/home.md diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md index d9eb8e29fff..bf666f867e7 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md @@ -8429,7 +8429,203 @@ This event occures whenever a user has had an opportunity to interact with your Feature flag impressions are only logged once per session. +{% tabs %} +{% tab Mixpanel %} +```json +// Feature Flag Experiment Impression: users.messages.featureflag.Impression + +{ + "event" : "(required, string) The event type name, as it is exported to Mixpanel", + "properties" : { + "$partner_id" : "braze", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "$device" : "(optional, string) Model of the device", + "distinct_id" : "(required, string) External ID of the user", + "feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "time" : "(required, int) UNIX timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token" + } +} +``` +{% endtab %} + +{% tab Cloud Storage %} +```json +// Feature Flag Experiment Impression: users.messages.featureflag.Impression + +{ + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "carrier" : "(optional, string) Carrier of the device", + "country" : "(optional, string) Country of the user", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "external_user_id" : "(optional, string) External ID of the user", + "feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier", + "gender" : "(optional, string) Gender of the user, one of ['M', 'F', 'O', 'N', 'P']", + "id" : "(required, string) Globally unique ID for this event", + "language" : "(optional, string) Language of the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "resolution" : "(optional, string) Resolution of the device", + "sdk_version" : "(optional, string) Version of the Braze SDK in use during the event", + "time" : "(required, int) UNIX timestamp at which the event happened", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) Braze user ID of the user who performed this event" +} +``` +{% endtab %} + +{% tab mParticle %} +```json +// Feature Flag Experiment Impression: users.messages.featureflag.Impression + +{ + "device_info" : { + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" + }, + "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", + "events" : [ + { + "data" : { + "custom_attributes" : { + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation" + }, + "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" + }, + "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" + } + ], + "schema_version" : 2, + "user_attributes" : { }, + "user_identities" : { + "customerid" : "(required, string) External ID of the user" + } +} +``` +{% endtab %} + +{% tab Amplitude %} +```json +// Feature Flag Experiment Impression: users.messages.featureflag.Impression + +{ + "device_id" : "(optional, string) ID of the device on which the event occurred", + "event_properties" : { + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_model" : "(optional, string) Model of the device", + "feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "timezone" : "(optional, string) Time zone of the user" + }, + "event_type" : "(required, string) The event type name, as it is exported to Amplitude", + "insert_id" : "(required, string) Globally unique ID for this event", + "library" : "Braze", + "time" : "(required, int) UNIX timestamp at which the event happened", + "user_id" : "(optional, string) External ID of the user" +} +``` +{% endtab %} +{% tab Segment %} +```json +// Feature Flag Experiment Impression: users.messages.featureflag.Impression + +{ + "context" : { + "traits" : { }, + "device" : { + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" + } + }, + "event" : "(required, string) The event type name, as it is exported to Segment", + "messageId" : "(required, string) Globally unique ID for this event", + "properties" : { + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "platform" : "(optional, string) Platform of the device" + }, + "timestamp" : "(required, int) UNIX timestamp at which the event happened", + "type" : "track", + "userId" : "(required, string) External ID of the user" +} +``` +{% endtab %} +{% endtabs %} {% endapi %} @@ -8934,11 +9130,173 @@ This event occurs when a user enters into the Canvas. This event tells you which ## Canvas step progression events {% apitags %} -Canvas, StepProgression +CanvasStep, Progression {% endapitags %} This event occurs when a user progresses through a step in a Canvas with some outcome. Currently, only split steps – Audience Paths, Decision Split, Action Paths, Experiment – and Advance outcomes generate Step Progression events. +{% tabs %} +{% tab Mixpanel %} +```json +// Canvas Step Progression: users.canvasstep.Progression + +{ + "event" : "(required, string) The event type name, as it is exported to Mixpanel", + "properties" : { + "$partner_id" : "braze", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas", + "next_step_id" : "(optional, string) API ID of the next step in the canvas", + "progression_type" : "(required, string) What type of step progression event this is", + "time" : "(required, int) UNIX timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token" + } +} +``` +{% endtab %} + +{% tab Cloud Storage %} +```json +// Canvas Step Progression: users.canvasstep.Progression +{ + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step", + "external_user_id" : "(optional, string) External ID of the user", + "id" : "(required, string) Globally unique ID for this event", + "is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas", + "next_step_id" : "(optional, string) API ID of the next step in the canvas", + "progression_type" : "(required, string) What type of step progression event this is", + "time" : "(required, int) UNIX timestamp at which the event happened", + "user_id" : "(required, string) Braze user ID of the user who performed this event" +} +``` +{% endtab %} + +{% tab mParticle %} +```json +// Canvas Step Progression: users.canvasstep.Progression + +{ + "device_info" : { + "ios_idfv" : "(optional, string) ID of the device on which the event occurred" + }, + "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", + "events" : [ + { + "data" : { + "custom_attributes" : { + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step", + "is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas", + "next_step_id" : "(optional, string) API ID of the next step in the canvas", + "progression_type" : "(required, string) What type of step progression event this is" + }, + "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" + }, + "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" + } + ], + "schema_version" : 2, + "user_attributes" : { }, + "user_identities" : { + "customerid" : "(required, string) External ID of the user" + } +} +``` +{% endtab %} + +{% tab Amplitude %} +```json +// Canvas Step Progression: users.canvasstep.Progression + +{ + "device_id" : "(optional, string) ID of the device on which the event occurred", + "event_properties" : { + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step", + "is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas", + "next_step_id" : "(optional, string) API ID of the next step in the canvas", + "progression_type" : "(required, string) What type of step progression event this is" + }, + "event_type" : "(required, string) The event type name, as it is exported to Amplitude", + "insert_id" : "(required, string) Globally unique ID for this event", + "library" : "Braze", + "time" : "(required, int) UNIX timestamp at which the event happened", + "user_id" : "(optional, string) External ID of the user" +} +``` +{% endtab %} + +{% tab Segment %} +```json +// Canvas Step Progression: users.canvasstep.Progression + +{ + "context" : { + "traits" : { }, + "device" : { } + }, + "event" : "(required, string) The event type name, as it is exported to Segment", + "messageId" : "(required, string) Globally unique ID for this event", + "properties" : { + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step", + "is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas", + "next_step_id" : "(optional, string) API ID of the next step in the canvas", + "progression_type" : "(required, string) What type of step progression event this is" + }, + "timestamp" : "(required, int) UNIX timestamp at which the event happened", + "type" : "track", + "userId" : "(required, string) External ID of the user" +} +``` +{% endtab %} +{% endtabs %} {% endapi %}