diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md index c2a6ab040a2..c7a582c7c90 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md @@ -56,21 +56,26 @@ This event occurs when a specific custom event is triggered. Use this to track w ```json // Custom Event: users.behaviors.CustomEvent { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "timezone": (string) IANA time zone of the user at the time of the event, - "name": (string) name of the custom event, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the event occurred, + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "app_group_id": (required, string) BSON id of the app group this user belongs to, + "app_id": (optional, string) id for the app on which the user action occurred, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "gender": (optional, string) [PII] gender of the user, + "country": (optional, string) [PII] country of the user, + "timezone": (optional, string) IANA time zone of the user at the time of the event, + "language": (optional, string) [PII] language of the user, + "device_id": (optional, string) id of the device on which the event occurred, + "sdk_version": (optional, string) version of the Braze SDK in use during the event, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of device used for the action, + "device_model": (optional, string) hardware model of the device, + "name": (required, string) name of the custom event, "properties": (string) JSON encoded string of the properties for this event, - "ad_id": (string) advertising identifier, - "ad_id_type": (string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id', - "ad_tracking_enabled": (boolean) whether advertising tracking is enabled for the device + "ad_id": (optional, string) advertising identifier, + "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id', + "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device } ``` @@ -96,22 +101,24 @@ Purchases are special custom events and come with a JSON encoded string of custo ```json // Purchase Event: users.behaviors.Purchase { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "product_id": (string) id of the product purchased, - "price": (float) price of the purchase, - "currency": (string) three letter alpha ISO 4217 currency code, - "properties": (string) JSON encoded string of the custom properties for this event, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the event occurred, - "ad_id": (string) advertising identifier, - "ad_id_type": (string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id', - "ad_tracking_enabled": (boolean) whether advertising tracking is enabled for the device + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "app_group_id": (required, string) BSON id of the app group this user belongs to, + "app_id": (optional, string) id for the app on which the user action occurred, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "device_id": (optional, string) id of the device on which the event occurred, + "sdk_version": (optional, string) version of the Braze SDK in use during the purchase, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of device used for the action, + "device_model": (optional, string) hardware model of the device, + "product_id": (required, string) id of the product purchased, + "price": (required, float) price of the purchase, + "currency": (required, string) three letter alpha ISO 4217 currency code, + "properties": (required, string) JSON encoded string of the custom properties for this event, + "ad_id": (optional, string) advertising identifier, + "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id', + "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device } ``` #### Property details @@ -137,21 +144,21 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar ```json // Session Start: users.behaviors.app.FirstSession { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "timezone": (string) IANA time zone of the user at the time of the event, - "session_id": (string) id of the session, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of the device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the session occurred, - "gender": (string) gender of the user, - "country": (string) country of the user, - "language": (string) language of the user, - "sdk_version": (string) version of the Braze SDK in use during the session + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "timezone": (optional, string) IANA time zone of the user at the time of the event, + "session_id": (required, string) id of the session, + "app_id": (required, string) id for the app on which the user action occurred, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of the device used for the action, + "device_model": (optional, string) hardware model of the device, + "device_id": (optional, string) id of the device on which the session occurred, + "gender": (optional, string) gender of the user, + "country": (optional, string) country of the user, + "language": (optional, string) language of the user, + "sdk_version": (optional, string) version of the Braze SDK in use during the session } ``` {% endapi %} @@ -173,16 +180,16 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar ```json // Session Start: users.behaviors.app.SessionStart { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "session_id": (string) id of the session, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of the device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the session occurred + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "session_id": (required, string) id of the session, + "app_id": (required, string) id for the app on which the user action occurred, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of the device used for the action, + "device_model": (optional, string) hardware model of the device, + "device_id": (optional, string) id of the device on which the session occurred } ``` @@ -205,17 +212,17 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar ```json // Session End: users.behaviors.app.SessionEnd { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "session_id": (string) id of the session, - "duration": (float) seconds session lasted, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of the device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the session occurred + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "session_id": (required, string) id of the session, + "duration": (optional, float) seconds session lasted, + "app_id": (required, string) id for the app on which the user action occurred, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of the device used for the action, + "device_model": (optional, string) hardware model of the device, + "device_id": (optional, string) id of the device on which the session occurred } ``` {% endapi %} @@ -233,23 +240,25 @@ This event is triggered when a user visits a specified location. Use this to tra ```json // Location Event: users.behaviors.Location { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "longitude": (float) longitude of recorded location, - "latitude": (float) latitude of recorded location, - "altitude": (float) altitude of recorded location, - "ll_accuracy": (float) latitude/longitude accuracy of recorded location, - "alt_accuracy": (float) altitude accuracy of recorded location, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the event occurred, - "ad_id": (string) advertising identifier, - "ad_id_type": (string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id', - "ad_tracking_enabled": (boolean) whether advertising tracking is enabled for the device + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "app_group_id": (required, string) BSON id of the app group this user belongs to, + "app_id": (required, string) id for the app on which the user action occurred, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "longitude": (required, float) longitude of recorded location, + "latitude": (required, float) latitude of recorded location, + "altitude": (optional, float) altitude of recorded location, + "ll_accuracy": (optional, float) latitude/longitude accuracy of recorded location, + "alt_accuracy": (optional, float) altitude accuracy of recorded location, + "device_id": (optional, string) id of the device on which the event occurred, + "sdk_version": (optional, string) version of the Braze SDK in use when the location was recorded, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of device used for the action, + "device_model": (optional, string) hardware model of the device, + "ad_id": (optional, string) advertising identifier, + "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id', + "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device } ``` #### Property details @@ -278,15 +287,15 @@ We do track other News Feed events; these are located in [Message Engagement Eve ```json // News Feed Impression: users.behaviors.app.NewsFeedImpression { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "app_id": (string) id for the app on which the user action occurred, - "platform": (string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), - "os_version": (string) os version of the device used for the action, - "device_model": (string) hardware model of the device, - "device_id": (string) id of the device on which the event occurred + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "app_id": (required, string) id for the app on which the user action occurred, + "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'), + "os_version": (optional, string) os version of the device used for the action, + "device_model": (optional, string) hardware model of the device, + "device_id": (optional, string) id of the device on which the event occurred } ``` @@ -304,11 +313,13 @@ This event occurs when an app installation is attributed to a source. Use this t ```json // Install Attribution Event: users.behaviors.InstallAttribution { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "source": (string) the source of the attribution + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "device_id": (optional, string) device_id that is tied to this user if user is anonymous, + "app_group_id": (required, string) BSON id of the app group this user belongs to, + "time": (requierd, int) 10-digit UTC time of the event in seconds since the epoch, + "source": (required, string) the source of the attribution } ``` 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 7f235a1179f..2cb46daef94 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 @@ -1828,29 +1828,26 @@ Subscription groups are only available for email and SMS channels at this time. ```json // Subscription Group State Change: users.behaviors.subscriptiongroup.StateChange { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "state_change_source": (string) Source of the state change, e.g: REST, SDK, Dashboard, Preference Center etc., - "channel": (string) either 'sms', 'email', or 'whats_app', - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "timezone": (string) IANA time zone of the user at the time of the event, - "app_id": (string) id for the app on which the user action occurred, - "campaign_id": (string) id of the campaign if from a campaign, - "campaign_name": (string) name of the campaign, - "message_variation_id": (string) id of the message variation if from a campaign, - "message_variation_name": (string) the name of the message variation if from a campaign, - "canvas_id": (string) id of the Canvas if from a canvas, - "canvas_name": (string) name of the Canvas, - "canvas_variation_id": (string) id of the Canvas variation the user is in if from a Canvas, - "canvas_variation_name": (string) name of the Canvas variation the user is in if from a Canvas, - "canvas_step_id": (string) id of the step for this message if from a Canvas, - "canvas_step_name": (string) name of the step for this message if from a Canvas, - "send_id": (string) id of the message if specified for the campaign (See Send Identifier under API Identifier Types), - "email_address": (string) email address for this user, - "phone_number": (string) phone number of the user (presented in e.164 format), - "subscription_group_id": (string) id of the subscription group, - "subscription_status": (string) status of the subscription after the change: 'Subscribed' or 'Unsubscribed' + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "device_id": (optional, string) device_id that is tied to this user if user is anonymous, + "app_group_id": (required, string) BSON id of the app group this user belongs to, + "email_address": (optional, string) email address for this user, + "phone_number": (optional, string) phone number of the user (presented in e.164 format), + "app_id": (optional, string) id for the app on which the user action occurred, + "campaign_id": (optional, string) id of the campaign if from a campaign, + "message_variation_id": (optional, string) id of the message variation if from a campaign, + "canvas_id": (optional, string) id of the Canvas if from a canvas, + "canvas_variation_id": (optional, string) id of the Canvas variation the user is in if from a Canvas, + "canvas_step_id": (optional, string) id of the step for this message if from a Canvas, + "subscription_group_id": (required, string) id of the subscription group, + "channel": (optional, string) either 'sms', 'email', or 'whats_app', + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch, + "subscription_status": (required, string) status of the subscription after the change: 'Subscribed' or 'Unsubscribed' + "timezone": (optional, string) IANA time zone of the user at the time of the event, + "send_id": (optional, string) id of the message if specified for the campaign (See Send Identifier under API Identifier Types), + "state_change_source": (optional, string) Source of the state change, e.g: REST, SDK, Dashboard, Preference Center etc., } ``` @@ -1890,26 +1887,23 @@ This event occurs when the global subscription state of the user changes. ```json // Global State Change: users.behaviors.subscription.GlobalStateChange { - "id": (string) unique ID of this event, - "user_id": (string) Braze BSON id of the user with this global subscription state change, - "external_user_id": (string) External ID of the user, - "email_address": (string) User email address, - "state_change_source": (string) Source of the state change, e.g: REST, SDK, Dashboard, Preference Center etc., - "subscription_status": (string) Global subscription status: Subscribed, Unsubscribed and Opt-In, - "channel": (string) Channel: only email for now, - "time": (string) 10-digit UTC time of the state change event in seconds since the epoch, - "timezone": (string) IANA timezone of the user at the time of the event, - "app_group_id": (string) BSON id of the app group this user belongs to, - "app_group_api_id": (string) API id of the app group this user belongs to, - "app_api_id": (string) API id of the app the event belongs to, - "campaign_id": (string) BSON id of the Campaign if from a Campaign, - "campaign_api_id": (string) API id of the Campaign if from a Campaign, - "message_variation_api_id": (string) API id of the message variation if from a Campaign, - "canvas_id": (string) BSON id of the Canvas if from a Canvas, - "canvas_api_id": (string) API id of the Canvas if from a Canvas, - "canvas_variation_api_id ": (string) API id of the Canvas variation if from a Canvas, - "canvas_step_api_id": (string) API id of the Canvas step if from a Canvas, - "send_id": (string) Message send id this subscription state change action originated from + "id": (required, string) unique ID of this event, + "user_id": (required, string) Braze BSON id of the user with this global subscription state change, + "external_user_id": (optional, string) External ID of the user, + "email_address": (optional, string) User email address, + "state_change_source": (optional, string) Source of the state change, e.g: REST, SDK, Dashboard, Preference Center etc., + "subscription_status": (required, string) Global subscription status: Subscribed, Unsubscribed and Opt-In, + "channel": (optional, string) Channel: only email for now, + "time": (required, string) 10-digit UTC time of the state change event in seconds since the epoch, + "timezone": (optional, string) IANA timezone of the user at the time of the event, + "app_group_id": (required, string) BSON id of the app group this user belongs to, + "app_id": (optional, string) BSON id of the app the event belongs to, + "campaign_id": (optional, string) BSON id of the Campaign if from a Campaign, + "message_variation_id": (optional, string) BSON id of the message variation this event belongs to, + "canvas_variation_id": (optional, string) BSON id of the canvas variation this event belongs to, + "canvas_id": (optional, string) BSON id of the Canvas if from a Canvas, + "canvas_step_id": (optional, string) BSON id of the canvas step this subscription state change originated from, + "send_id": (optional, string) Message send id this subscription state change action originated from } ``` @@ -1951,12 +1945,13 @@ This event is not fired when the user actually uninstalls the app, as that's imp ```json // Uninstall Event: users.behaviors.Uninstall { - "id": (string) unique id of this event, - "user_id": (string) Braze user id of the user, - "external_user_id": (string) External ID of the user, - "time": (int) 10-digit UTC time of the event in seconds since the epoch, - "app_id": (string) id for the app on which the user action occurred, - "device_id": (string) id of the device on which the session occurred + "id": (required, string) unique id of this event, + "user_id": (required, string) Braze user id of the user, + "external_user_id": (optional, string) External ID of the user, + "device_id": (optional, string) id of the device on which the session occurred, + "app_group_id": (optional, string) BSON id of the app group this user belongs to, + "app_id": (required, string) id for the app on which the user action occurred, + "time": (required, int) 10-digit UTC time of the event in seconds since the epoch } ```