Skip to content
Get Help

Event Ontology Field Reference

This reference lists every field in the Branch Event Ontology with its type, whether you or Branch sets it, and which event types include it. Use it to see what to send when you build an integration, and what you can expect downstream in exports, webhooks, and the API.

How to read this reference ​

Fields are grouped by family. Each table lists:

  • Field: The field name as it appears in exports and the API.
  • Type: The data type, including the allowed values for enums.
  • Set by: Who populates the field. Client means you send it from the SDK or API, Server means Branch derives it, and Client or server means either can supply it.
  • Events: Which event types include the field. All means all twelve event types.
  • Description: What the field represents.

Note: event types and naming

For what each event type means and the SDK constants that map to it, see Branch Event Ontology.

Field name conventions ​

Branch adds a prefix to each deep link data key to show where it comes from. In field names, those prefixes are spelled out: dollar_ for $ (a Branch reserved keyword), tilde_ for ~ (an analytics label), and plus_ for + (data Branch adds). For example, content_items[].dollar_price is the $price key. To learn more about the prefixes, see Deep Linking Full Reference.

Field reference ​

The ontology defines 273 distinct fields across the twelve event types. 88 of them appear in every event type, and the rest apply to a subset, as shown in the Events column.

Event fields (103 fields)

Fields that describe the event itself, the app, the device, and the session.

FieldTypeSet byEventsDescription
android_app_link_urlstringClientAll except IMPRESSION, VIEWA client-specified web URL (Branch or non-Branch) that opens an Android app via Android App Links.
attributedbooleanServerAll except IMPRESSION, CLICK, VIEWWhether the event is attributed. Will always be accompanied by last_attributed_touch_type and last_attributed_touch_data.
custom_datamap[string->string]ClientAll except IMPRESSION, CLICK, VIEWPartner-specified custom key-value pairs associated with an event, excluding Touches, Branch CTA view.
customer_event_aliasstringClientCOMMERCE, CONTENT, LIFECYCLE, CUSTOMTUNE customers can specify that an event of type "purchase" should have name "buy20tokens". The customer_event_alias captures this name, which is additional information. For most events this is likely unnecessary. Exposed in Webhooks and Exports for TUNE customers only.
datasourceenum { IMPRESSION, CLICK, BRANCH_CTA_VIEW, INSTALL, OPEN, REINSTALL, PAGEVIEW, WEB_SESSION_START, COMMERCE_EVENT, CUSTOM_EVENT, CONTENT_EVENT, USER_LIFECYCLE_EVENT }ServerAllConvenience dimension for internal use.
days_from_install_to_opt_inintServerOPEN, INSTALLNumber of days between when the first install (user_data_opted_in= false) and when this event occurred.
days_from_last_attributed_touch_to_eventintServerAll except IMPRESSION, CLICK, VIEWNumber of days between when the last touch occurred and when this event subsequently occurred.
deep_linkedbooleanServerAll except IMPRESSION, CLICK, VIEWTrue if the current app or web session resulted in the user being deep linked.
di_match_click_tokenintServerCLICK, LIFECYCLEBranch Flow ID. Should be internal only, but used by Tune, Appsflyer, and others to match a click to an install, using the Android install referrer. Set server side, relayed by the client.
event_timestampintServerAllUnix timestamp in milliseconds of when the event actually happened. Generally identical to timestamp for most implementations but could differ for backdated events or s2s integrations.
existing_userbooleanClientAll except IMPRESSION, CLICK, VIEWThis is TUNE's existing_user flag. Pass-through field.
first_event_for_userbooleanServerAll except IMPRESSION, CLICK, VIEWIf this is the first time for this persona that this event has been triggered.
fraud_bool_suspiciousbooleanServerAllIndicates whether the underlying event (such as a click or install) was flagged as suspicious or fake by fraud detection. This typically triggers when traffic originates from known bad IPs, emulators, server farms, or TOR networks.
fraud_bool_suspicious_attributionbooleanServerAllIndicates whether the attribution relationship was flagged as fraudulent by fraud detection. While the install itself might be real, the ad interaction claiming credit is suspicious (often used to detect Install Hijacking, Click Injection, or Click Flooding based on abnormal click-to-install latency times).
fraud_descriptionsarray[string]ServerAllContains the descriptions of the specific fraud detection rule(s) that flagged the event. Examples of values include 'Suspicious Device', 'Click Injection', 'Device Conflict', 'Geo Conflict', or 'Persona Fraud'.
hours_from_last_attributed_touch_to_eventintServerOPEN, INSTALL, REINSTALL, LIFECYCLENumber of hours between when the last touch occurred and when this event subsequently occurred. CAPPED AT 24.
idstringServerAllA unique id for the event.
install_activity_timestampintServerAll except IMPRESSION, CLICK, VIEWAn epoch timestamp for the time of the install in UTC in milliseconds.
install_activity_touch_data_dollar_meta_is_mobile_data_terms_signedbooleanServerAll except IMPRESSION, CLICK, VIEWWhether Meta's mobile data terms have been signed for the Install Touch. When true, Meta does not require Branch to scrub Meta-related data from this record.
install_activity_touch_data_tilde_campaignstringClient or serverAll except IMPRESSION, CLICK, VIEWCampaign (name) specified for the install activity. Can be specified on links by the client, or prefilled automatically server side in some cases.
install_activity_touch_data_tilde_channelstringClient or serverAll except IMPRESSION, CLICK, VIEWChannel specified for the install activity. Can be specified on links by the client, or prefilled automatically server side in some cases.
install_activity_touch_data_tilde_featurestringClient or serverAll except IMPRESSION, CLICK, VIEWFeature specified for the install activity. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_timestampintServerAll except IMPRESSION, CLICK, VIEWUnix timestamp in milliseconds for the last attributed touch.
last_attributed_touch_typeenum { CLICK, IMPRESSION }ServerAll except IMPRESSION, CLICK, VIEWWhether the last attributed touch was an impression or a click.
last_cta_view_data_custom_fieldsstringClientAll except IMPRESSION, CLICK, VIEWStringified JSON representing custom data specified for the last Branch CTA view e.g. {foo:true}.
last_cta_view_data_dollar_3pstringClientAll except IMPRESSION, CLICK, VIEWAdvertising partner short-code (e.g. e_rs) specified for the last Branch CTA view.
last_cta_view_data_dollar_meta_is_mobile_data_terms_signedbooleanServerAll except IMPRESSION, CLICK, VIEWWhether Meta's mobile data terms have been signed for the Last CTA View Touch. When true, Meta does not require Branch to scrub Meta-related data from this CTA view record.
last_cta_view_data_plus_referring_domainstringClientAll except IMPRESSION, CLICK, VIEWDomain of the URL that the user visited before landing on a page with a Journey. This should use the same data source that we use for the "came directly from a URL" audience filter.
last_cta_view_data_plus_touch_idstringServerAll except IMPRESSION, CLICK, VIEWThe attributing touch's (impression, click, etc.) id.
last_cta_view_data_plus_via_featuresenum { EMAIL, ADS, DESKTOP_JOURNEYS, MOBILE_JOURNEYS, DESKTOP_DEEPVIEWS, MOBILE_DEEPVIEWS, SOCIAL, QUICK_LINKS }ServerAll except IMPRESSION, CLICK, VIEWAll Branch features (determined by Branch) which were determined, via attribution, to have led to this event. For example, if an email link click leads to a Journeys CTA view, the published eo_branch_cta_view will have +via_features: [EMAIL, JOURNEYS].
last_cta_view_data_plus_web_formatenum { AMP, INSTANT_ARTICLES }ClientAll except IMPRESSION, CLICK, VIEWSet if an event originated with a Branch CTA view on Google AMP or Facebook Instant Article. Specified by the client.
last_cta_view_data_tilde_ad_idstringServerAll except IMPRESSION, CLICK, VIEWAd id specified for the last Branch CTA view.
last_cta_view_data_tilde_ad_namestringServerAll except IMPRESSION, CLICK, VIEWAd name specified for the last Branch CTA view.
last_cta_view_data_tilde_ad_set_idstringServerAll except IMPRESSION, CLICK, VIEWAd set id specified for the last Branch CTA view.
last_cta_view_data_tilde_ad_set_namestringServerAll except IMPRESSION, CLICK, VIEWAd set name specified for the last Branch CTA view.
last_cta_view_data_tilde_advertising_partner_idstringClient or serverAll except IMPRESSION, CLICK, VIEWID for advertising partner specified for the last Branch CTA view.
last_cta_view_data_tilde_advertising_partner_namestringServerAll except IMPRESSION, CLICK, VIEWHuman-readable advertising partner name specified for the last Branch CTA view.
last_cta_view_data_tilde_agencystringClientAll except IMPRESSION, CLICK, VIEWAgency of the last touch, as set with an analytics tag. Agency that runs ad campaigns on behalf of advertiser.
last_cta_view_data_tilde_agency_idstringClientAll except IMPRESSION, CLICK, VIEWID of agency of the last touch, as set with an analytics tag. Agency that runs ad campaigns on behalf of advertiser.
last_cta_view_data_tilde_banner_dimensionsstringClientAll except IMPRESSION, CLICK, VIEWDimensions of display banner of the last touch, as set with an analytics tag.
last_cta_view_data_tilde_branch_ad_formatstringServerAll except IMPRESSION, CLICK, VIEWAd format of the last touch. Ad Format chosen upon Branch link creation and set as an analytics tag. e.g. Search, Display, Product Ad, App only.
last_cta_view_data_tilde_campaignstringClient or serverAll except IMPRESSION, CLICK, VIEWCampaign (name) specified for the last Branch CTA view. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_data_tilde_campaign_idstringServerAll except IMPRESSION, CLICK, VIEWCampaign id specified for the last Branch CTA view.
last_cta_view_data_tilde_campaign_typestringServerAll except IMPRESSION, CLICK, VIEWCampaign type. Google AAP field.
last_cta_view_data_tilde_channelstringClient or serverAll except IMPRESSION, CLICK, VIEWChannel specified for the last Branch CTA view. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_data_tilde_creative_idstringServerAll except IMPRESSION, CLICK, VIEWCreative id specified for the last Branch CTA view.
last_cta_view_data_tilde_creative_namestringServerAll except IMPRESSION, CLICK, VIEWCreative name specified for the last Branch CTA view.
last_cta_view_data_tilde_customer_ad_namestringClientAll except IMPRESSION, CLICK, VIEWCustomer ad name specified for the last Branch CTA view. Can be specified on links by the client.
last_cta_view_data_tilde_customer_ad_set_namestringClientAll except IMPRESSION, CLICK, VIEWCustomer ad set name specified for the last Branch CTA view. Can be specified on links by the client.
last_cta_view_data_tilde_customer_campaignstringClientAll except IMPRESSION, CLICK, VIEWCustomer campaign specified for the last Branch CTA view. Can be specified by links on the client.
last_cta_view_data_tilde_customer_keywordstringClientAll except IMPRESSION, CLICK, VIEWCustomer keyword of the last touch. Can be specified on links by the client.
last_cta_view_data_tilde_customer_placementstringClientAll except IMPRESSION, CLICK, VIEWCustomer specified placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.
last_cta_view_data_tilde_customer_secondary_publisherstringClientAll except IMPRESSION, CLICK, VIEWCustomer secondary publisher specified for the last Branch CTA view. Can be specified on links by the client.
last_cta_view_data_tilde_customer_sub_site_namestringClientAll except IMPRESSION, CLICK, VIEWCustomer reference to the site where the ad was displayed. Can be specified on links by the client.
last_cta_view_data_tilde_external_touch_idstringServerAll except IMPRESSION, CLICK, VIEWThe id of click or impression (view) sent to Branch from a third party. Used to tie an attributed event back to the original touch.
last_cta_view_data_tilde_featurestringClient or serverAll except IMPRESSION, CLICK, VIEWFeature specified for the last Branch CTA view. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_data_tilde_idintServerAll except IMPRESSION, CLICK, VIEWThe id for the last Branch CTA view.
last_cta_view_data_tilde_journey_idstringServerAll except IMPRESSION, CLICK, VIEWAudience rule id for a Journey.
last_cta_view_data_tilde_journey_namestringClient or serverAll except IMPRESSION, CLICK, VIEW"Campaign Name" or "title" for an audience rule / Journey. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_data_tilde_keywordstringServerAll except IMPRESSION, CLICK, VIEWKeyword specified for the last Branch CTA view.
last_cta_view_data_tilde_keyword_idstringGoogleAll except IMPRESSION, CLICK, VIEWUnique ID for keyword of the last touch as provided by Google.
last_cta_view_data_tilde_optimization_modelstringClientAll except IMPRESSION, CLICK, VIEWOptimization model of the last touch, as set with an analytics tag. Model detailing the event for which the campaign is optimizing, e.g. for installs, clicks, events.
last_cta_view_data_tilde_placementstringClientAll except IMPRESSION, CLICK, VIEWPlacement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.
last_cta_view_data_tilde_placement_idstringClientAll except IMPRESSION, CLICK, VIEWID of placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.
last_cta_view_data_tilde_secondary_ad_formatstringClientAll except IMPRESSION, CLICK, VIEWSecondary ad format of the last touch, as set with an analytics tag or during ad link creation flow in the dashboard. Ad Partner Specific Ad format, such as Display Engagement Ad for Google.
last_cta_view_data_tilde_secondary_publisherstringAd networkAll except IMPRESSION, CLICK, VIEWSecondary publisher specified for the last Branch CTA view.
last_cta_view_data_tilde_secondary_publisher_idstringAd networkAll except IMPRESSION, CLICK, VIEWThe id of the secondary publisher specified for the last Branch CTA view.
last_cta_view_data_tilde_stagestringClient or serverAll except IMPRESSION, CLICK, VIEWStage specified for the last Branch CTA view. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_data_tilde_sub_site_namestringAd networkAll except IMPRESSION, CLICK, VIEWReference to the site where the ad was displayed.
last_cta_view_data_tilde_tagsarray[string]Client or serverAll except IMPRESSION, CLICK, VIEWTags specified for the last Branch CTA view. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_data_tilde_technology_partnerstringClientAll except IMPRESSION, CLICK, VIEWTechnology partner of last touch, as set with an analytics tag. Any third party that's used to enhance a campaign (e.g. audiences being provided, creative optimization), with the exception of agencies.
last_cta_view_data_tilde_tune_publisher_idintClientAll except IMPRESSION, CLICK, VIEWPublisher id of the last touch. TUNE-specific variable for one customer's ad network enablement. In general, last_attributed_touch_data_tilde_advertising_partner_name is a better field to use.
last_cta_view_data_tilde_tune_publisher_namestringClientAll except IMPRESSION, CLICK, VIEWPublisher name of the last touch. TUNE-specific variable for one customer's ad network enablement. In general, last_attributed_touch_data_tilde_advertising_partner_name is a better field to use.
last_cta_view_data_tilde_tune_publisher_sub1stringClientAll except IMPRESSION, CLICK, VIEWGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_cta_view_data_tilde_tune_publisher_sub2stringClientAll except IMPRESSION, CLICK, VIEWGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_cta_view_data_tilde_tune_publisher_sub3stringClientAll except IMPRESSION, CLICK, VIEWGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_cta_view_data_tilde_tune_publisher_sub4stringClientAll except IMPRESSION, CLICK, VIEWGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_cta_view_data_tilde_tune_publisher_sub5stringClientAll except IMPRESSION, CLICK, VIEWGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_cta_view_data_tilde_view_idstringServerAll except IMPRESSION, CLICK, VIEWBranch view id for a Journey.
last_cta_view_data_tilde_view_namestringClient or serverAll except IMPRESSION, CLICK, VIEW"View Name" or "title" for a branch view / template. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_cta_view_timestampintServerAll except IMPRESSION, CLICK, VIEWUnix timestamp in milliseconds for the last Branch CTA view.
match_guaranteedbooleanServerAll except IMPRESSION, CLICK, VIEWIndicates if the match was made with 100% accuracy through deterministic methods.
minutes_from_last_attributed_touch_to_eventintServerOPEN, INSTALL, REINSTALL, LIFECYCLENumber of minutes between when the last touch occurred and when this event subsequently occurred. CAPPED AT 60.
namestringServerAllThe name of the event, in this case IMPRESSION.
organization_idintServerAllThe id of the organization for which the event occurred.
organization_namestringServerAllThe name of the organization for which the event occurred.
originenum { BRANCH, SEGMENT, MPARTICLE, TUNE }ServerAllWhether the event originated with a Branch SDK/API call, or was sent by Segment or mParticle.
persona_identifiers[].guaranteedarray[boolean]ServerAllWhether id found in persona_identifiers[].id definitely belongs to this user (if false, we used probabilistic edges).
persona_identifiers[].idarray[string]ServerAllDevice, browser, or user id.
persona_identifiers[].typearray[string]ServerAllType of id found in the persona_identifiers[].id dimension.
reengagement_activity_touch_data_dollar_meta_is_mobile_data_terms_signedbooleanServerAll except IMPRESSION, CLICK, VIEWWhether Meta's mobile data terms have been signed for the Reengagement Touch. When true, Meta does not require Branch to scrub Meta-related data from this reengagement record.
referrer_click_timestampintServerOPEN, INSTALL, REINSTALL, LIFECYCLEThe time of the Play Store launch (Android only, TUNE-migrated customers only).
request_idstringServerAll except IMPRESSIONA Branch generated identifier used to track the request through our pipeline.
seconds_from_last_attributed_touch_to_eventintServerOPEN, INSTALL, REINSTALL, LIFECYCLENumber of seconds between when the last touch occurred and when this event subsequently occurred. CAPPED AT 60.
store_install_begin_timestampintServerOPEN, INSTALL, REINSTALL, LIFECYCLEThe time the install button is clicked in the Play Store / App Store (TUNE-migrated customers only).
timestampintServerAllUnix timestamp in milliseconds for the event.
tune_site_event_idintClientAll except WEB SESSION START, PAGEVIEWTUNE's event id. Per-site.
tune_site_idintClientAllThe id of the TUNE site (comparable to Branch's app_id).
tune_site_namestringClientAllThe name of the TUNE site.
universal_link_urlstringClientAll except IMPRESSION, VIEWA client-specified web URL (Branch or non-Branch) that opens an iOS app via Apple Universal Links.
webhook_request_headersmap[string->string]ServerLIFECYCLERequest headers.
webhook_request_urlstringServerLIFECYCLERequest URL.
webhook_response_codeintServerLIFECYCLECode returned in the response by the third party.
Attribution fields (last_attributed_touch_data) (63 fields)

Fields describing the ad touchpoint Branch attributed the event to. Useful downstream for reporting on campaign performance.

FieldTypeSet byEventsDescription
last_attributed_touch_data_custom_fieldsstringClientAllAny deep link data specified for the last touch not captured by the above fields e.g. {foo:true, $deeplink_path: 'id/12'}. "custom_fields" should not be surfaced as an independent object. The values should be included in last_attributed_touch_data.
last_attributed_touch_data_dollar_3pstringClientAllAdvertising partner short-code (e.g. e_rs) specified for the last attributed touch.
last_attributed_touch_data_dollar_fb_data_terms_not_signedbooleanServerAll except IMPRESSION, CLICK, VIEWWhether the mobile data terms are not signed from Facebook. This means we need to hide everything attribution-related from external events.
last_attributed_touch_data_dollar_marketing_titlestringServerAllQuick Link title.
last_attributed_touch_data_dollar_meta_is_mobile_data_terms_signedbooleanServerAllWhether Meta's mobile data terms have been signed for the Last Attributed Touch. When true, Meta does not require Branch to scrub Meta-related data from this attribution record.
last_attributed_touch_data_plus_attribution_methodstringServerAllThe specific signal, mechanism, identifier, or framework used to link the conversion event to a marketing touchpoint (e.g., ADVERTISING_ID, GCLID, GBRAID, AEM, PERSONA).
last_attributed_touch_data_plus_attribution_method_typestringServerAllClassifies the broader category of methodology used to generate or validate the attribution signal, grouping methods based on reliability or privacy frameworks (e.g., PARTNER_DETERMINISTIC, PARTNER_CLICK_IDENTIFIERS, BRANCH_MODELLED, PARTNER_PRIVACY_FRAMEWORK).
last_attributed_touch_data_plus_current_featureenum { EMAIL, ADS, DESKTOP_JOURNEYS, MOBILE_JOURNEYS, DESKTOP_DEEPVIEWS, MOBILE_DEEPVIEWS, SOCIAL, QUICK_LINKS }ServerIMPRESSION, CLICK, VIEW, LIFECYCLEBranch feature (determined by Branch) of the current touch.
last_attributed_touch_data_plus_referring_domainstringClientAll except IMPRESSIONDomain of the URL that the user visited before landing on a page with a Journey. This should use the same data source that we use for the "came directly from a URL" audience filter.
last_attributed_touch_data_plus_touch_idstringServerAllThe attributing touch's (impression, click, etc.) id.
last_attributed_touch_data_plus_via_featuresenum { EMAIL, ADS, DESKTOP_JOURNEYS, MOBILE_JOURNEYS, DESKTOP_DEEPVIEWS, MOBILE_DEEPVIEWS, SOCIAL, QUICK_LINKS }ServerAll except IMPRESSIONAll Branch features (determined by Branch) which were determined, via attribution, to have led to this event. For example, if an email link click leads to a Journey which leads to the app, the published eo_open will have +via_features: [EMAIL, JOURNEYS].
last_attributed_touch_data_plus_web_formatenum { AMP, INSTANT_ARTICLES }ClientAllSet if an event originated with a touch on Google AMP or Facebook Instant Article.
last_attributed_touch_data_tilde_ad_idstringServerAllThe ad id specified for the last attributed touch.
last_attributed_touch_data_tilde_ad_namestringServerINSTALL, REINSTALLThe ad name specified for the last attributed touch.
last_attributed_touch_data_tilde_ad_set_idstringServerINSTALL, REINSTALLThe ad set id specified for the last attributed touch.
last_attributed_touch_data_tilde_ad_set_namestringServerINSTALL, REINSTALLThe ad set name specified for the last attributed touch.
last_attributed_touch_data_tilde_advertising_partner_idstringClient or serverAllID for the advertising partner specified for the last attributed touch. For now, specific to partners migrating from TUNE.
last_attributed_touch_data_tilde_advertising_partner_namestringServerAllHuman-readable advertising partner name specified for the last attributed touch.
last_attributed_touch_data_tilde_agencystringClientAllAgency of the last touch, as set with an analytics tag. Agency that runs ad campaigns on behalf of advertiser.
last_attributed_touch_data_tilde_agency_idstringClientAllID of agency of the last touch, as set with an analytics tag. Agency that runs ad campaigns on behalf of advertiser.
last_attributed_touch_data_tilde_banner_dimensionsstringClientAllDimensions of display banner of the last touch, as set with an analytics tag.
last_attributed_touch_data_tilde_branch_ad_formatstringClientAllAd format of the last touch. Ad Format chosen upon Branch link creation and set as an analytics tag. e.g. Search, Display, Product Ad, App only.
last_attributed_touch_data_tilde_campaignstringClient or serverAllCampaign (name) specified for the last attributed touch. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_data_tilde_campaign_idstringServerAllCampaign id specified for the last attributed touch.
last_attributed_touch_data_tilde_campaign_typestringServerAllCampaign type. Google AAP field.
last_attributed_touch_data_tilde_channelstringClient or serverAllChannel specified for the last attributed touch. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_data_tilde_content_idstringServerAllContent ID of the link; used for Roku and other OTT content.
last_attributed_touch_data_tilde_creative_idstringServerAllCreative id specified for the last attributed touch.
last_attributed_touch_data_tilde_customer_ad_namestringClientAllThe customer ad name specified for the last attributed touch. Can be specified on the link by the client.
last_attributed_touch_data_tilde_customer_ad_set_namestringAd networkAllCustomer ad set name specified for the last attributed touch.
last_attributed_touch_data_tilde_customer_campaignstringClient or serverAllCustomer campaign specified for the last attributed touch. Can be specified on links by the client.
last_attributed_touch_data_tilde_customer_keywordstringClientAllCustomer keyword of the last touch. Can be specified on links by the client.
last_attributed_touch_data_tilde_customer_placementstringClientAllCustomer specified placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.
last_attributed_touch_data_tilde_customer_secondary_publisherstringAd networkAllCustomer secondary publisher specified for the last attributed touch.
last_attributed_touch_data_tilde_customer_sub_site_namestringClientAllCustomer reference to the site where the ad was displayed. Can be specified on links by the client.
last_attributed_touch_data_tilde_external_touch_idstringAd networkAllThe id of click or impression (view) sent to Branch from a third party. Used to tie an attributed event back to the original touch. Where the attributed partner is Google SAN, this will be the gclid value. See gclid in this sheet for more information.
last_attributed_touch_data_tilde_featurestringClient or serverAllFeature specified for the last attributed touch. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_data_tilde_idlongServerAll except IMPRESSIONThe id for the last attributed touch (Quick Links only).
last_attributed_touch_data_tilde_journey_idstringServerAll except IMPRESSIONAudience rule id for a Journey.
last_attributed_touch_data_tilde_journey_namestringClient or serverAll except IMPRESSION"Campaign Name" or "title" for an audience rule / Journey. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_data_tilde_keywordstringServerAllThe keyword specified for the last attributed touch.
last_attributed_touch_data_tilde_keyword_idstringGoogleAllUnique ID for keyword of the last touch as provided by Google.
last_attributed_touch_data_tilde_keyword_match_typestringServerAll except IMPRESSION, CLICK, VIEWHow the keyword the user searched got matched to the ad, e.g. Broad, Exact, Phrase, Search Match.
last_attributed_touch_data_tilde_optimization_modelstringClientAllOptimization model of the last touch, as set with an analytics tag. Model detailing the event for which the campaign is optimizing, e.g. for installs, clicks, events.
last_attributed_touch_data_tilde_organic_search_urlstringServerAll except IMPRESSIONThe organic search URL that the topic has been last attributed to.
last_attributed_touch_data_tilde_placementstringClientAllPlacement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.
last_attributed_touch_data_tilde_placement_idstringClientAllID of placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.
last_attributed_touch_data_tilde_secondary_ad_formatstringClientAllSecondary ad format of the last touch, as set with an analytics tag or during ad link creation flow in the dashboard. Ad Partner Specific Ad format, such as Display Engagement Ad for Google.
last_attributed_touch_data_tilde_secondary_publisherstringAd networkAllSecondary publisher specified for the last attributed touch.
last_attributed_touch_data_tilde_secondary_publisher_idstringAd networkAllThe id of secondary publisher specified for the last attributed touch.
last_attributed_touch_data_tilde_stagestringClient or serverAllStage specified for the last attributed touch. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_data_tilde_sub_site_namestringAd networkAllReference to the site where the ad was displayed.
last_attributed_touch_data_tilde_tagsarray[string]Client or serverAllTags specified for the last attributed touch. Can be specified on links by the client, or prefilled automatically server side in some cases.
last_attributed_touch_data_tilde_technology_partnerstringClientAllTechnology partner of last touch, as set with an analytics tag. Any third party that's used to enhance a campaign (e.g. audiences being provided, creative optimization), with the exception of agencies.
last_attributed_touch_data_tilde_tune_publisher_idintClientAllPublisher id of the last touch. TUNE-specific variable for one customer's ad network enablement. In general, last_attributed_touch_data_tilde_advertising_partner_name is a better field to use.
last_attributed_touch_data_tilde_tune_publisher_namestringClientAllPublisher name of the last touch. TUNE-specific variable for one customer's ad network enablement. In general, last_attributed_touch_data_tilde_advertising_partner_name is a better field to use.
last_attributed_touch_data_tilde_tune_publisher_sub1stringClientAllGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_attributed_touch_data_tilde_tune_publisher_sub2stringClientAllGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_attributed_touch_data_tilde_tune_publisher_sub3stringClientAllGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_attributed_touch_data_tilde_tune_publisher_sub4stringClientAllGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_attributed_touch_data_tilde_tune_publisher_sub5stringClientAllGeneral-purpose field for passing data from click through to installs, opens, and conversion events.
last_attributed_touch_data_tilde_view_idstringServerAll except IMPRESSIONBranch view id for a Journey.
last_attributed_touch_data_tilde_view_namestringClient or serverAll except IMPRESSION"View Name" or "title" for a branch view / template. Can be specified on links by the client, or prefilled automatically server side in some cases.
User and device fields (user_data) (56 fields)

Fields describing the user and their device at the time of the event.

FieldTypeSet byEventsDescription
user_data_aaidstringClientAll except VIEW, WEB SESSION START, PAGEVIEWAndroid/Google advertising id of the device where the event occurred.
user_data_android_idstringClientAll except IMPRESSION, VIEW, WEB SESSION START, PAGEVIEWAndroid hardware id. Can only be reset by wiping the device.
user_data_app_package_namestringClientAll except IMPRESSION, VIEW, WEB SESSION START, PAGEVIEWTUNE uses this to look up the site the request is for. site_id is preferred as it is more specific. Also used in webhooks.
user_data_app_storestringClientOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMSpecifies which app store the app was downloaded for.
user_data_app_versionstringClientAll except IMPRESSION, VIEW, WEB SESSION START, PAGEVIEWApp version where the event occurred.
user_data_brandstringClientAllBrand of the device where the event occurred.
user_data_browserstringClientAll except OPEN, INSTALL, REINSTALLA human-readable name for the browser from which the web event originated. Derived from user-agent string.
user_data_buildstringServerOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMThe build version of the device. TUNE-migrated customers only.
user_data_carrier_namestringServerOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMThe name of the carrier (e.g. Verizon) of the device. TUNE-migrated customers only.
user_data_cpp_levelstringClientAllConsumer Protection Preference level.
user_data_cpu_typestringServerOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMThe type of central processing unit used by the device. TUNE-migrated customers only.
user_data_cross_platform_idstringServerAllAn app-scoped unique identifier for the Branch Persona for which this event occurred.
user_data_developer_identitystringClientAllDeveloper-specified identity for a user.
user_data_device_typeenum { ANDROID_PHONE, ANDROID_TABLET, DESKTOP, IOS_PHONE, IOS_TABLET, OTHER, TV_OS, UNKNOWN, WINDOWS_PHONE, WINDOWS_TABLET }ClientAllTUNE historically has categorized devices for convenience aggregate analytics. Similar to user_data_platform, with the addition of Windows devices and specifying phone vs tablet.
user_data_dma_ad_personalizationbooleanClientAllIndicates whether the end-user has explicitly granted or denied ads personalization consent. Set to true if consent is granted, and false if denied.
user_data_dma_ad_user_databooleanClientAllIndicates whether the end-user has explicitly granted or denied consent for the 3rd-party transmission of user-level data for advertising purposes. Set to true if consent is granted, and false if denied. Required if user_data_dma_eea is set to true.

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation.
user_data_dma_eeabooleanClientAllIndicates whether European regulations, including the Digital Markets Act (DMA), apply to this user and conversion. Set to true if the user is included in European Union regulations (e.g., located within the EEA), and false if they are excluded. Required if EU regulations apply to this user.

Warning: Failure to include user consent signals may result in attribution or campaign performance degradation.
user_data_environmentenum { FULL_WEB, FULL_APP, IMESSAGE_APP, INSTANT_APP }ClientAllRuntime environment where the event occurred, which can distinguish between e.g. full app vs instant app.
user_data_geo_city_codeintServerAllCity code, derived from IP address (above).
user_data_geo_city_enstringServerAllHuman-readable city, derived from IP address (above).
user_data_geo_country_codestringServerAllCountry code, derived from IP address (above).
user_data_geo_country_enstringServerAllCountry name in English, derived from IP address (above).
user_data_geo_dma_codeintServerAllDMA code, derived from IP address (above). https://support.google.com/richmedia/answer/2745487?hl=en
user_data_geo_latdoubleServerAllLatitude, derived from IP address (above).
user_data_geo_londoubleServerAllLongitude, derived from IP address (above).
user_data_geo_postal_codestringServerAllPostal code, derived from IP address (above).
user_data_geo_region_codestringServerAllRegion code, derived from IP address (above).
user_data_geo_region_enstringServerAllHuman-readable region, derived from IP address (above).
user_data_http_referrerstringClientAll except OPEN, INSTALL, REINSTALLReferral url that led to the current page where Web SDK logged web session start.
user_data_idfastringClientAll except VIEW, WEB SESSION START, PAGEVIEWiOS advertising id of the device where the event occurred.
user_data_idfvstringClientAll except IMPRESSION, VIEW, WEB SESSION START, PAGEVIEWiOS vendor id of the device where the event occurred. Scoped to a vendor e.g. Facebook: idfv is the same for Facebook and Messenger but different Twitter.
user_data_installer_package_namestringServerOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMThe package name of the app that installed the app. TUNE-migrated customers only.
user_data_internet_connection_typestringServerOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMThe type of connection to the internet (e.g. Wifi) used by the device. TUNE-migrated customers only.
user_data_ipstringServerAllIP address from which the API call tracking the event originated. Set automatically server side.
user_data_is_jailbrokenbooleanClientAllIf true, then the phone that sent this event was jailbroken.
user_data_kindle_idstringServerAll except VIEW, WEB SESSION START, PAGEVIEWKindle ID.
user_data_languagestringClientAllLanguage specified in the user_agent string (or in some cases other headers).
user_data_limit_ad_trackingbooleanClientAll except CLICKTrue if the partner has opted to not be tracked by advertisers. On iOS 10+, accompanied by idfa of 0s.
user_data_modelstringClientAllModel of the device where the event occurred.
user_data_oaidstringServerAll except VIEWThe Open Anonymous Device Identifier (OAID) is used for advertising purposes in place of the non-supported Google Advertising ID for specific device manufacturers. The Branch SDK collects OAID and uses it for attribution on clicks and impressions.
user_data_opted_inbooleanClientOPEN, INSTALLBoolean for whether the second OPEN can be inferred as INSTALL after opt-in. If set, the event can be considered as our synthetic OPEN generated by api-open by inspecting incoming event parameters with persona data. If the event is not considered as the second OPEN, the flag is not present. Only available for iOS 14.5 or higher.
user_data_opted_in_statusenum { not_determined, restricted, denied, authorized }ClientOPEN, INSTALL, REINSTALLOpted in Status is for iOS 14.5 and above users where the ATT Prompt status is defined and passed to Branch Servers via the SDK.
user_data_osenum { AMAZON_FIRE, AMAZON_FIRE_TV, ANDROID, BADA, BEOS, BLACKBERRY, BSD, CENTOS, CHROMIUM_OS, DEBIAN, DRAGONFLY, FEDORA, FIREFOX_OS, FREEBSD, GENTOO, GN, IOS, JOLI, KUBUNT, LINUX, MAC_OS, MANDRIVA, MEEGO, MINT, NETBSD, NINTENDO, OPENBSD, OS_2, OTHER, PLAYSTATION, RIM_TABLET_OS, ROBOTS, SAILFISH, SLACKWARE, SOLARIS, SUSE, SYMBIAN, TIZEN, TVOS, UBUNT, UNIX, WINDOWS, WINDOWS_PHONE, ZENWALK }ClientAllThe OS of the device where the event occurred. Note that robots includes web and app robots for easy filtering.
user_data_os_versionstringClientAllThe OS version (iOS) or API version (Android) of the device where the event occurred.
user_data_os_version_androidstringClientAllThe OS version (Android) of the device where the event occurred.
user_data_past_cross_platform_idsarray[string]ServerAllA list of past cross_platform_id values associated with this Branch Persona. Enables identifying Personas that have been merged together.
user_data_platformenum { ANDROID_APP, ANDROID_TV, ANDROID_WEB, DESKTOP_WEB, FIRE_APP, IOS_APP, IOS_TV, IOS_WEB, MAC_APP, OTHER, ROBOT, WINDOWS_APP }ClientAllConvenience dimension that allows users to easily see web vs app, desktop vs mobile, and iOS vs Android vs other. Derived from information specified by the client.
user_data_prob_cross_platform_ids[].idarray[string]ServerAllA list of past cross_platform_id values that are probabilistically associated with this Branch Persona. Enables identifying Personas that may be the same.
user_data_prob_cross_platform_ids[].probabilityarray[double]ServerAllA list of past cross_platform_id values that are probabilistically associated with this Branch Persona. Enables identifying Personas that may be the same.
user_data_referral_sourcestringClientAll except IMPRESSION, VIEW, WEB SESSION START, PAGEVIEWAndroid: activity.getCallingPackage(). iOS: Web referrer, safari referrer, or bundle_id.
user_data_screen_heightintServerAll except IMPRESSION, VIEW, WEB SESSION STARTThe width of the screen of the device. TUNE-migrated customers only.
user_data_screen_widthintServerAll except IMPRESSION, VIEW, WEB SESSION STARTThe width of the screen of the device. TUNE-migrated customers only.
user_data_sdk_versionstringClientAll except IMPRESSION, VIEWBranch SDK version used to track this event.
user_data_tune_mat_idstringClient or serverAll except VIEW, WEB SESSION START, PAGEVIEWTUNE User id generated by the SDK. Can also be set server-side if not set. Not shared across customers. Can be attached to a TUNE click, and subsequent events with the same mat_id can be attributed back to that click.
user_data_user_agentstringClientAllUser agent of the browser or app where the event occurred. Usually associated with a webview.
user_data_windows_aidstringServerAll except VIEW, WEB SESSION START, PAGEVIEWWindows Advertising ID.
Content item fields (content_items) (36 fields)

Fields describing the individual products or content in the event. Sent as an array, so one event can carry many items.

FieldTypeSet byEventsDescription
content_items[].custom_fieldsarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEPartner-specified custom key-value pairs associated with a BUO.
content_items[].dollar_address_cityarray[string]ClientCOMMERCE, CONTENT, LIFECYCLECity for a restaurant, business, room (hotel), etc.
content_items[].dollar_address_countryarray[string]ClientCOMMERCE, CONTENT, LIFECYCLECountry code for a restaurant, business, room (hotel), etc.
content_items[].dollar_address_postal_codearray[string]ClientCOMMERCE, CONTENT, LIFECYCLEPostal/zip code for a restaurant, business, room (hotel), etc.
content_items[].dollar_address_regionarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEState or region for a restaurant, business, room (hotel), etc.
content_items[].dollar_address_streetarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEStreet address for a restaurant, business, room (hotel), etc.
content_items[].dollar_canonical_identifierarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEUsed to allow Branch to unify content/messages.
content_items[].dollar_canonical_urlarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEA web URL which refers to the content on the public web (mobile or desktop). Preferably is a permalink, and used as canonical URL elsewhere (main website, AMP pages, etc.).
content_items[].dollar_conditionenum { NEW, EXCELLENT, GOOD, FAIR, POOR, USED, REFURBISHED, OTHER }ClientCOMMERCE, CONTENT, LIFECYCLEFor auctions, whether the item is new, good, acceptable, etc.
content_items[].dollar_content_schemaenum { COMMERCE_AUCTION, COMMERCE_BUSINESS, COMMERCE_OTHER, COMMERCE_PRODUCT, COMMERCE_RESTAURANT, COMMERCE_SERVICE, COMMERCE_TRAVEL_FLIGHT, COMMERCE_TRAVEL_HOTEL, COMMERCE_TRAVEL_OTHER, GAME_STATE, MEDIA_IMAGE, MEDIA_MIXED, MEDIA_MUSIC, MEDIA_OTHER, MEDIA_VIDEO, OTHER, TEXT_ARTICLE, TEXT_BLOG, TEXT_OTHER, TEXT_RECIPE, TEXT_REVIEW, TEXT_SEARCH_RESULTS, TEXT_STORY, TEXT_TECHNICAL_DOC }ClientCOMMERCE, CONTENT, LIFECYCLECategory / schema for a piece of content.
content_items[].dollar_creation_timestamparray[int]ClientCOMMERCE, CONTENT, LIFECYCLETime the content was created.
content_items[].dollar_currencyarray[string]ClientCOMMERCE, CONTENT, LIFECYCLECurrency code for a BUO.
content_items[].dollar_exp_datearray[int]ClientCOMMERCE, CONTENT, LIFECYCLEThe last time after which this content is no longer valid. Using null / 0 means no limit.
content_items[].dollar_image_captionsarray[string]ClientCOMMERCE, CONTENT, LIFECYCLECaptions associated with the image.
content_items[].dollar_keywordsarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEAny keywords.
content_items[].dollar_latitudearray[double]ClientCOMMERCE, CONTENT, LIFECYCLELatitude for a restaurant, business, room (hotel), etc.
content_items[].dollar_locally_indexablearray[boolean]ClientCOMMERCE, CONTENT, LIFECYCLEIf true, content can be indexed for local (device) use. If false, content cannot index for local use.
content_items[].dollar_longitudearray[double]ClientCOMMERCE, CONTENT, LIFECYCLELongitude for a restaurant, business, room (hotel), etc.
content_items[].dollar_og_descriptionarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEDescription (for individual item).
content_items[].dollar_og_image_urlarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEImage URL.
content_items[].dollar_og_titlearray[string]ClientCOMMERCE, CONTENT, LIFECYCLEThe rendered document title (also for searching) - if a collection then the title for the collection not the individual items.
content_items[].dollar_pricearray[double]ClientCOMMERCE, CONTENT, LIFECYCLEUnit price for the product/content.
content_items[].dollar_price_in_usdarray[double]Client or serverCOMMERCE, CONTENT, LIFECYCLEUnit price in USD, based off of price, currency, and exchange rate.
content_items[].dollar_product_brandarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEProduct's brand.
content_items[].dollar_product_categoryenum { ANIMALS_AND_PET_SUPPLIES, APPAREL_AND_ACCESSORIES, ARTS_AND_ENTERTAINMENT, BABY_AND_TODDLER, BUSINESS_AND_INDUSTRIAL, CAMERAS_AND_OPTICS, ELECTRONICS, FOOD_BEVERAGES_AND_TOBACCO, FURNITURE, HARDWARE, HEALTH_AND_BEAUTY, HOME_AND_GARDEN, LUGGAGE_AND_BAGS, MATURE, MEDIA, OFFICE_SUPPLIES, RELIGIOUS_AND_CEREMONIAL, SOFTWARE, SPORTING_GOODS, TOYS_AND_GAMES, VEHICLES_AND_PARTS }ClientCOMMERCE, CONTENT, LIFECYCLEProduct category, if product.
content_items[].dollar_product_namearray[string]ClientCOMMERCE, CONTENT, LIFECYCLEProduct's name.
content_items[].dollar_product_variantarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEProduct variant (e.g. XL).
content_items[].dollar_publicly_indexablearray[boolean]ClientCOMMERCE, CONTENT, LIFECYCLEIf true, content can be seen by anyone. If false, content cannot index for public use.
content_items[].dollar_quantityarray[double]ClientCOMMERCE, CONTENT, LIFECYCLEQuantity of the item to be ordered (for PURCHASE, ADD_TO_CART, etc.).
content_items[].dollar_ratingarray[double]ClientCOMMERCE, CONTENT, LIFECYCLERating given by the user on a RATE event.
content_items[].dollar_rating_averagearray[double]ClientCOMMERCE, CONTENT, LIFECYCLEAverage rating of the item.
content_items[].dollar_rating_countarray[int]ClientCOMMERCE, CONTENT, LIFECYCLENumber of ratings for the item.
content_items[].dollar_rating_maxarray[double]ClientCOMMERCE, CONTENT, LIFECYCLEMaximum possible rating for the item (e.g. 5 stars is highest possible rating).
content_items[].dollar_skuarray[string]ClientCOMMERCE, CONTENT, LIFECYCLEProduct sku or product id.
content_items[].dollar_valuearray[double]ServerCOMMERCE, CONTENT, LIFECYCLEValue is the product of $price multiplied by $quantity.
content_items[].dollar_value_in_usdarray[double]ServerCOMMERCE, CONTENT, LIFECYCLEValue in USD (see $value above), based off of price, currency, and exchange rate.
Event detail fields (event_data) (15 fields)

Fields describing the transaction or interaction, such as revenue, currency, and search query.

FieldTypeSet byEventsDescription
event_data_ad_typeenum { BANNER, INTERSTITIAL, REWARDED_VIDEO, NATIVE }ClientCOMMERCE, CONTENT, LIFECYCLEAd type that the user saw or clicked on. Defined by Facebook.
event_data_affiliationstringClientCOMMERCE, CONTENT, LIFECYCLEStore or affiliation from which this transaction occurred (e.g. Google Store).
event_data_couponstringClientCOMMERCE, CONTENT, LIFECYCLETransaction coupon redeemed with the transaction (e.g. "SPRING2017").
event_data_currencystringClientCOMMERCE, CONTENT, LIFECYCLECurrency that revenue, price, shipping, tax were originally reported in by the partner.
event_data_custom_param_1stringClientOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMCustom parameter 1 for your event.
event_data_custom_param_2stringClientOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMCustom parameter 2 for your event.
event_data_custom_param_3stringClientOPEN, INSTALL, REINSTALL, COMMERCE, CONTENT, LIFECYCLE, CUSTOMCustom parameter 3 for your event.
event_data_descriptionstringClientCOMMERCE, CONTENT, LIFECYCLEDescription associated with the event, not necessarily specific to any individual content items.
event_data_exchange_ratedoubleClientCOMMERCE, CONTENT, LIFECYCLEExchange rate from the time the event occurred (may be up to 24 hours old but is typically updated within the hour).
event_data_revenuedoubleClientCOMMERCE, CONTENT, LIFECYCLEPartner-specified revenue for the event.
event_data_revenue_in_usddoubleServerCOMMERCE, CONTENT, LIFECYCLERevenue in USD, based off of revenue, currency, and exchange rate.
event_data_search_querystringClientCOMMERCE, CONTENT, LIFECYCLESearch query associated with the event.
event_data_shippingdoubleClientCOMMERCE, CONTENT, LIFECYCLEShipping cost associated with the transaction. Specified by the client.
event_data_taxdoubleClientCOMMERCE, CONTENT, LIFECYCLETotal tax associated with the transaction.
event_data_transaction_idstringClientCOMMERCE, CONTENT, LIFECYCLE, CUSTOMPartner-specified transaction id for their internal use.