Skip to main content
All CollectionsData ConnectorsCustom Connectors
How to request Branch Query Analytics in Funnel
How to request Branch Query Analytics in Funnel

Leverage your Branch data in Funnel via Custom Connectors.

Kelsey Maynard avatar
Written by Kelsey Maynard
Updated over a week ago

The Branch Query Analytics API offers events data unavailable in Funnel's Branch Core Connector. If your use case requires these events in Funnel, you can request them as a Custom Connector.

Custom Connectors and the Custom Connector Request feature are available in the following plans: Business and Enterprise. See our Pricing page for more details.


Metrics

All metrics can be pulled with the following aggregations (unique count, total count, revenue, cost). Due to the API, unique metrics can only be pulled at a maximum 7 day rolling window. To learn more about unique metrics from Branch, see: Comparing Unique Branch Data in Funnel

  • Impression: Loading of a user generated and placed impression pixel for the purpose of creating an attributing event from a marketing effort. By this definition, no automated renders from Branch (e.g. Journeys, Deepviews) are impressions, nor are views of content in the app.

  • Click: A user initiated action of tapping on a Branch link or html element directly in front of a Branch link

  • Open: A mobile app launch that is not an install (ie not a first time app launch for that persona). An "open" ends when an app is backgrounded or closed.

  • Install: The first time an app launches for a given IDFA/AAID. (Excludes cases where the IDFA is reset with the app still installed.)

  • Reinstall: When an app is deleted then re-installed on the same device (same device is defined as same IDFA/AAID).

  • Web Session Start: A website launch (ie first page view). A session is considered to end after 30 minutes of inactivity (ie not launching a page or triggering an event).

  • Pageview: A pageview is the loading of a single page for a given website which is triggered more specifically, by calling branch.init() or branch.track('pageview')

  • Commerce Event: A standard event where a customer is on a journey to pay money to a business. It excludes views, but includes adding to cart through to purchasing. [Uses Branch event tracking code or the Data Ingestion pipeline. Each event within it is a point in time action.] Revenue is attached to this topic based on cost and event metadata.

  • Content Event: A standard event involving content that may or may not be a product, but excludes events where a customer is on a journey to pay money to a business (adding to cart to purchasing).

  • Custom Event: Custom event is a non-standard user tracked event.

  • User Lifecycle Event: A standard event not involving content.

Custom Events

Custom events are any events you choose to track with Branch that fall outside our list of standard events.

User Lifecycle Events

User lifecycle events are events marking a distinct action completed by a user as they progress through your app, such as COMPLETE_REGISTRATION.

  • Complete Registration

  • Complete Tutorial

  • Achieve Level

  • Unlock Achievement

  • Invite

  • Login

  • Start Trial

  • Subscribe

Content Events

Content events include a short list of events such as VIEW_ITEM that involve content and are not directly related to e-commerce.

  • Search

  • View Item

  • View Items

  • Rate

  • Share

  • Initiate Stream

  • Complete Stream

Commerce Events

Commerce events include purchases and transactions, as well as actions related to carts and wishlists.

  • Add to Cart

  • Add to Wishlist

  • View Cart

  • Initiate Purchase

  • Add Payment Info

  • Click Ad

  • Purchase

  • Reserve

  • Spend Credits

  • View Ad

Dimensions

  • Attributed: whether the event is attributed. will always be accompanied by last_attributed_touch_type and last_attributed_touch_data. set automatically server side.

  • Customer Event Alias: TUNE customers can specify that an event of type "purchase" should have name "buy20tokens". 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.

  • Days From Install To Opt In: number of days between when the first install (user_data_opted_in= false) and when this event occurred

  • Days From Last Attributed Touch To Event: number of days between when the last touch occurred and when this event subsequently occurred. set automatically server side.

  • Deep Linked: true if the current app or web session resulted in the user being deep linked. set automatically server side.

  • Di Match Click Token: Branch Flow ID. Should be internal only, but used by Tune, Appsflyer and other to match a click to an install, using the Android install referrer. set server side, relayed by the client.

  • Event Data Ad Type: Ad type that the user saw or clicked on. Defined by Facebook. specified by the client.

  • Event Data Affiliation: Store or affiliation from which this transaction occurred (e.g. Google Store). specified by the client.

  • Event Data Coupon: Transaction coupon redeemed with the transaction (e.g. "SPRING2017"). specified by the client.

  • Event Data Currency: Currency that revenue, price, shipping, tax were orginally reported in by the partner. specified by the client.

  • Event Data Description: Description associated with the event, not necessarily specific to any individual content items. specified by the client.

  • Event Data Exchange Rate: exchange rate from the time the event occurred (may be up to 24 hours old but is typically updated within the hour). specified by the client.

  • Event Data Revenue: partner-specified revenue for the event. specified by the client.

  • Event Data Search Query: Search query associated with the event. specified by the client.

  • Event Data Shipping: Shipping cost associated with the transaction. specified by the client.

  • Event Data Tax: Total tax associated with the transaction. specified by the client.

  • Event Data Transaction Id: partner-specified transaction id for their internal use. specified by the client.

  • Event Timestamp: unix 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 User: this is TUNE's existing_user flag. Pass-through field. specified by the client.

  • First Event For User: if this is the first time for this persona that this event has been triggered. set automatically server side.

  • Hours From Last Attributed Touch To Event: number of hours between when the last touch occurred and when this event subsequently occurred. CAPPED AT 24. set automatically server side.

  • Id: a unique id for the event. set automatically server side.

  • Install Activity Timestamp: An epoch timestamp for the time of the install in UTC in milliseconds

  • Install Activity Touch Data Tilde Campaign: campaign (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 Channel: channel 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 Feature: feature specified for the install activity. can be specified on links by the client, or prefilled automatically server side in some cases.

  • Match Guaranteed: indicates if the match was made with 100% accuracy through deterministic methods

  • Minutes From Last Attributed Touch To Event: number of minutes between when the last touch occurred and when this event subsequently occurred. CAPPED AT 60. set automatically server side.

  • Name: the name of the event, such as "CLICK", "INSTALL", "PURCHASE", or custom event names like "signup". set either by the client (e.g. custom events) or automatically server side.

  • Organization Id: the id of the organization for which the event occurred. set automatically server side.

  • Organization Name: the name of the organization for which the event occurred. set automatically server side.

  • Origin: whether the event originated with a Branch SDK/API call, or was sent by Segment or mParticle. set automatically server side.

  • Referrer Click Timestamp: the time of the Play Store launch (Android only, TUNE-migrated customers only)

  • Seconds From Last Attributed Touch To Event: number of seconds between when the last touch occurred and when this event subsequently occurred. CAPPED AT 60. set automatically server side.

  • Store Install Begin Timestamp: the time the install button is clicked in the Play Store / App Store (TUNE-migrated customers only)

  • Timestamp: unix timestamp in milliseconds for the event. set automatically server side.

Last Attributed Touch Data

  • Last Attributed Touch Data Custom Fields: Any 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. specified by the client.

  • Last Attributed Touch Data Dollar 3P: advertising partner short-code (e.g. e_rs) specified for the last attributed touch. specified by the client.

  • Last Attributed Touch Data Dollar Fb Data Terms Not Signed: if the mobile data terms are not signed from facebook. this means we need to hide everything attribution-related from external events. set automatically server side.

  • Last Attributed Touch Data Dollar Marketing Title: Quick Link title

  • Last Attributed Touch Data Plus Current Feature: Branch feature (determined by Branch) of the current touch. set automatically server side.

  • Last Attributed Touch Data Plus Referring Domain: Domain 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. specified by the client.

  • Last Attributed Touch Data Plus Touch Id: the attributing touch's (impression, click, etc) id

  • Last Attributed Touch Data Plus Via Features: All 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]. set automatically server side.

  • Last Attributed Touch Data Plus Web Format: set if an event originated with a touch on Google AMP or Facebook Instant Article. specified by the client.

  • Last Attributed Touch Data Tilde Ad Id: ad id specified for the last attributed touch. set automatically server side.

  • Last Attributed Touch Data Tilde Advertising Partner Id: ID for the advertising partner specified for the last attributed touch. set automatically server side OR specified by the client. for now, specific to partners migrating from TUNE.

  • Last Attributed Touch Data Tilde Advertising Partner Name: human-readable advertising partner name specified for the last attributed touch. set automatically server side.

  • Last Attributed Touch Data Tilde Agency: 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 Agency Id: ID 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 Dimensions: Dimensions of display banner of the last touch, as set with an analytics tag.

  • Last Attributed Touch Data Tilde Branch Ad Format: Ad 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 Campaign: campaign (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 Id: campaign id specified for the last attributed touch. set automatically server side.

  • Last Attributed Touch Data Tilde Campaign Type: campaign type. Google AAP field. set automatically server side.

  • Last Attributed Touch Data Tilde Channel: channel 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 Id: Content ID of the link; used for Roku and other OTT content

  • Last Attributed Touch Data Tilde Creative Id: creative id specified for the last attributed touch. set automatically server side.

  • Last Attributed Touch Data Tilde Customer Ad Name: 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 Name: customer ad set name specified for the last attributed touch. passed by the ad network.

  • Last Attributed Touch Data Tilde Customer Campaign: customer campaign specified for the last attributed touch. can be specified on links by the client.

  • Last Attributed Touch Data Tilde Customer Keyword: Customer keyword of the last touch. Can be specified on links by the client.

  • Last Attributed Touch Data Tilde Customer Placement: Customer 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 Publisher: customer secondary publisher specified for the last attributed touch. passed by the ad network.

  • Last Attributed Touch Data Tilde Customer Sub Site Name: Customer reference to the site where the ad was displayed. Can be specified on links by the client.

  • Last Attributed Touch Data Tilde External Touch Id: 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 Feature: feature 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 Id: id for the last attributed touch (Quick Links only). set automatically server side.

  • Last Attributed Touch Data Tilde Journey Id: Audience rule id for a Journey. set automatically server side.

  • Last Attributed Touch Data Tilde Journey Name: 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 Keyword: keyword specified for the last attributed touch. set automatically server side.

  • Last Attributed Touch Data Tilde Keyword Id: Unique ID for keyword of the last touch as provided by Google.

  • Last Attributed Touch Data Tilde Keyword Match Type: how the keyword the user searched got matched to the ad, e.g. Broad, Exact, Phrase, Search Match.

  • Last Attributed Touch Data Tilde Optimization Model: Optimization 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 Url: the organic search URL that the topic has been last attributed to.

  • Last Attributed Touch Data Tilde Placement: 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 Placement Id: ID 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 Format: Secondary 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 Publisher: secondary publisher specified for the last attributed touch. passed by the ad network.

  • Last Attributed Touch Data Tilde Secondary Publisher Id: id of secondary publisher specified for the last attributed touch. passed by the ad network.

  • Last Attributed Touch Data Tilde Stage: stage 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 Name: Reference to the site where the ad was displayed. passed by the ad network.

  • Last Attributed Touch Data Tilde Tags: tags 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 Partner: Technology 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 Id: Publisher 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 Name: Publisher 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 Sub1: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Attributed Touch Data Tilde Tune Publisher Sub2: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Attributed Touch Data Tilde Tune Publisher Sub3: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Attributed Touch Data Tilde Tune Publisher Sub4: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Attributed Touch Data Tilde Tune Publisher Sub5: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Attributed Touch Data Tilde View Id: Branch view id for a Journey. set automatically server side.

  • Last Attributed Touch Data Tilde View Name: 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 Attributed Touch Timestamp: unix timestamp in milliseconds for the last attributed touch. set automatically server side.

  • Last Attributed Touch Type: whether the last attributed touch was an impression, a click. set automatically server side.

Last CTA View Data

  • Last Cta View Data Custom Fields: stringified JSON representing custom data specified for the last Branch CTA view e.g. {foo:true}. specified by the client.

  • Last Cta View Data Dollar 3P: advertising partner short-code (e.g. e_rs) specified for the last Branch CTA view. specified by the client.

  • Last Cta View Data Plus Referring Domain: Domain 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. specified by the client.

  • Last Cta View Data Plus Touch Id: the attributing touch's (impression, click, etc) id

  • Last Cta View Data Plus Via Features: All 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]. set automatically server side.

  • Last Cta View Data Plus Web Format: set 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 Id: ad id specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Ad Name: ad name specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Ad Set Id: ad set id specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Ad Set Name: ad set name specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Advertising Partner Id: ID for advertising partner specified for the last Branch CTA view. set automatically server side OR specified by the client.

  • Last Cta View Data Tilde Advertising Partner Name: human-readable advertising partner name specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Agency: 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 Agency Id: ID 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 Dimensions: Dimensions of display banner of the last touch, as set with an analytics tag.

  • Last Cta View Data Tilde Branch Ad Format: Ad 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 Campaign: campaign (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 Id: campaign id specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Campaign Type: campaign type. Google AAP field. set automatically server side.

  • Last Cta View Data Tilde Channel: channel 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 Id: creative id specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Creative Name: creative name specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Customer Ad Name: customer 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 Name: customer ad set name specified for the last Branch CTA view. can be specified on links by the client.

  • Last Cta View Data Tilde Customer Campaign: customer campaign specified for the last Branch CTA view. can be specified by links on the client.

  • Last Cta View Data Tilde Customer Keyword: Customer keyword of the last touch. Can be specified on links by the client.

  • Last Cta View Data Tilde Customer Placement: Customer 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 Publisher: customer 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 Name: Customer reference to the site where the ad was displayed. Can be specified on links by the client.

  • Last Cta View Data Tilde External Touch Id: 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 Feature: feature 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 Id: id for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Journey Id: Audience rule id for a Journey. set automatically server side.

  • Last Cta View Data Tilde Journey Name: 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 Keyword: keyword specified for the last Branch CTA view. set automatically server side.

  • Last Cta View Data Tilde Keyword Id: Unique ID for keyword of the last touch as provided by Google.

  • Last Cta View Data Tilde Optimization Model: Optimization 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 Placement: 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 Placement Id: ID 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 Format: Secondary 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 Publisher: secondary publisher specified for the last Branch CTA view. passed by the ad network.

  • Last Cta View Data Tilde Secondary Publisher Id: id of the secondary publisher specified for the last Branch CTA view. passed by the ad network.

  • Last Cta View Data Tilde Stage: stage 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 Name: Reference to the site where the ad was displayed. passed by the ad network.

  • Last Cta View Data Tilde Tags: tags 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 Partner: Technology 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 Id: Publisher 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 Name: Publisher 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 Sub1: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Cta View Data Tilde Tune Publisher Sub2: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Cta View Data Tilde Tune Publisher Sub3: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Cta View Data Tilde Tune Publisher Sub4: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Cta View Data Tilde Tune Publisher Sub5: General-purpose field for passing data from click through to installs, opens, and conversion events.

  • Last Cta View Data Tilde View Id: Branch view id for a Journey. set automatically server side.

  • Last Cta View Data Tilde View Name: 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 Timestamp: unix timestamp in milliseconds for the last Branch CTA view. set automatically server side.

User Data

  • User Data Aaid: Android/Google advertising id of the device where the event occurred. specified by the client.

  • User Data Android Id: Android hardware id. Can only be reset by wiping the device. specified by the client.

  • User Data App Package Name: TUNE uses this to look up the site the request is for. site_id is preferred as it is more specific. Also used in webhooks. specified by the client.

  • User Data App Store: specifies which app store the app was downloaded for

  • User Data App Version: app version where the event occurred. specified by the client.

  • User Data Brand: brand of the device where the event occurred. specified by the client.

  • User Data Browser: A human-readable name for the browser from which the web event originated. Derived from user-agent string. specified by the client.

  • User Data Build: the build version of the device. set automatically server-side. (TUNE-migrated customers only).

  • User Data Carrier Name: the name of the carrier (e.g. Verizon) of the device. set automatically server side. (TUNE-migrated customers only)

  • User Data Cpu Type: the type of central processing unit used by the device. set automatically server side. (TUNE-migrated customers only).

  • User Data Cross Platform Id: an app-scoped unique identifier for the Branch Persona for which this event occurred. set automatically server side.

  • User Data Developer Identity: developer-specified identity for a user. specified by the client.

  • User Data Device Type: TUNE 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 Environment: runtime environment where the event occurred, which can distinguish between e.g. full app vs instant app. specified by the client.

  • User Data Geo City Code: city code, derived from IP address (above), set automatically server side.

  • User Data Geo City En: human-readable city, derived from IP address (above), set automatically server side.

  • User Data Geo Country Code: country code, derived from IP address (above), set automatically server side.

  • User Data Geo Country En: country name in English, derived from IP address (above), set automatically server side.

  • User Data Geo Dma Code: dma code, derived from IP address (above). https://support.google.com/richmedia/answer/2745487?hl=en, set automatically server side.

  • User Data Geo Postal Code: postal code, derived from IP address (above), set automatically server side.

  • User Data Geo Region Code: region code, derived from IP address (above), set automatically server side.

  • User Data Geo Region En: human-readable region, derived from IP address (above), set automatically server side.

  • User Data Http Referrer: referral url that led to the current page where Web SDK logged web session start. specified by the client.

  • User Data Idfa: iOS advertising id of the device where the event occurred. specified by the client.

  • User Data Idfv: iOS 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. specified by the client.

  • User Data Installer Package Name: the package name of the app that installed the app. set automatically server side. (TUNE-migrated customers only).

  • User Data Internet Connection Type: the type of connection to the internet (e.g. Wifi) used by the device. set automatically server side. (TUNE-migrated customers only).

  • User Data Is Jailbroken: If true, then the phone that sent this event was jailbroken. specified by the client.

  • User Data Kindle Id: Kindle ID.

  • User Data Language: language specified in the user_agent string (or in some cases other headers), specified by the client.

  • User Data Limit Ad Tracking: true if the partner has opted to not be tracked by advertisers. on iOS 10+, accompanied by idfa of 0s. specified by the client.

  • User Data Model: model of the device where the event occurred. specified by the client.

  • User Data Oaid: The 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 In: Boolean for whether the second OPEN can be infered as INSTALL after opt-in. If set, the event can be considered as our synthetic OPEN generated by api-open by inspecting incoming event paramters with persona data. If the event is not considered as the second OPEN, the flag is not present. Only available for iOS14.5 or higher

  • User Data Opted In Status: Opted 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 Os: os of the device where the event occurred. note that robots includes web and app robots for easy filtering. specified by the client.

  • User Data Os Version: os version (iOS) or API version (Android) of the device where the event occurred. specified by the client.

  • User Data Os Version Android: os version (Android) of the device where the event occurred. specified by the client.

  • User Data Past Cross Platform Ids: a list of past cross_platform_id values associated with this Branch Persona. enables identifying Personas that have been merged together. set automatically server side.

  • User Data Platform: convenience 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 Referral Source: Android: activity.getCallingPackage(). iOS: Web referrer, safari referrer, or bundle_id

  • User Data Screen Height: the width of the screen of the device. set automatically server side. (TUNE-migrated customers only).

  • User Data Screen Width: the width of the screen of the device. set automatically server side. (TUNE-migrated customers only).

  • User Data Sdk Version: Branch SDK version used to track this event. specified by the client.

  • User Data Tune Mat Id: TUNE 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 Agent: user agent of the browser or app where the event occurred. Usually associated with a webview. specified by the client.

  • User Data Windows Aid: Windows Advertising ID.

Did this answer your question?