Branch - Custom Export API: Most-used fields

Branch - Custom Export API: Most-used fields#

The table below gives information about most-used fields that you can import from Branch - Custom Export API. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Annotation Conversion Vale Mapped Value

annotation_conversion_value_mapped_value

The mapped conversion value associated with an annotation.

dimension

Annotation Customer Event Alias

annotation_customer_event_alias

The customer event alias associated with an annotation.

dimension

Annotation Dollar 3P

annotation_dollar_3p

The 3rd party advertising partner value associated with an annotation.

dimension

Annotation Revenue Lower Bound

annotation_revenue_lower

The lower bound of the revenue range associated with an annotation.

dimension

Annotation Revenue Upper Bound

annotation_revenue_upper

The upper bound of the revenue range associated with an annotation.

dimension

Body Attribution Signature

body_attribution_signature

The attribution signature for an SKAdNetwork postback.

dimension

Body Conversion Value

body_conversion_value

The conversion value for an SKAdNetwork postback.

dimension

Body Did Win

body_did_win

Indicates if an SKAdNetwork postback was a winning postback.

dimension

Body Fidelity Type

body_fidelity_type

The fidelity type for an SKAdNetwork postback, indicating the attribution model.

dimension

Branch App ID

app_id

The unique identifier for the Branch app.

dimension

Branch Organization ID

organization_id

The unique identifier for the Branch organization.

dimension

Invalid Reason

invalid_reason

The reason why a SKAdNetwork postback was considered invalid.

dimension

SKAdNetwork Ad Network ID

body_ad_network_id

The Ad Network ID from an SKAdNetwork postback.

dimension

SKAdNetwork App ID (App Store ID)

body_app_id

The App Store ID from an SKAdNetwork postback.

dimension

SKAdNetwork Redownload

body_redownload

Indicates if the app associated with the SKAdNetwork postback was a re-download.

dimension

SKAdNetwork Source App ID

body_source_app_id

The source App ID from an SKAdNetwork postback.

dimension

SKAdNetwork Transaction ID

body_transaction_id

The transaction ID from an SKAdNetwork postback.

dimension

SKAdNetwork Version

body_version

The version of SKAdNetwork used for the postback.

dimension

SKAdNetworkCampaign ID

body_campaign_id

The campaign ID from an SKAdNetwork postback.

dimension

app_id

app_id

Unique identifier for the Branch application.

dimension

content_items

content_items

An array of structured data representing content items related to the event.

dimension

custom_data

custom_data

A map of custom key-value pairs associated with the event.

dimension

customer_event_alias

customer_event_alias

An alias for the customer event, often a custom name defined by the user.

dimension

date

date

The timestamp of the event or activity, provided in ISO-8601 format for precise date and time tracking. This field can represent various event timestamps within the exported data.

dimension

days_from_last_attributed_touch_to_event

days_from_last_attributed_touch_to_event

The number of days between the last attributed touch and the event.

metric

deep_linked

deep_linked

Indicates whether the user was deep-linked to specific content within the application.

dimension

di_match_click_token

di_match_click_token

The Match Click Token for deep linking.

dimension

event_data_affiliation

event_data_affiliation

The affiliation associated with the event.

dimension

event_data_coupon

event_data_coupon

The coupon code used in the event.

dimension

event_data_currency

event_data_currency

The currency used for the event’s revenue.

dimension

event_data_description

event_data_description

A descriptive text for the event.

dimension

event_data_exchange_rate

event_data_exchange_rate

The exchange rate applied for the event’s revenue.

dimension

event_data_revenue

event_data_revenue

The revenue generated by the event.

metric

event_data_revenue_in_usd

event_data_revenue_in_usd

The revenue generated by the event, converted to USD.

metric

event_data_search_query

event_data_search_query

The search query associated with the event.

dimension

event_data_shipping

event_data_shipping

The shipping cost associated with the event.

dimension

event_data_tax

event_data_tax

The tax amount associated with the event.

dimension

event_data_transaction_id

event_data_transaction_id

The unique identifier for the transaction associated with the event.

dimension

event_timestamp

event_timestamp

The Unix timestamp of when the event occurred.

metric

existing_user

existing_user

Indicates if the user was an existing user at the time of the event.

dimension

external_intent_uri

external_intent_uri

The external URI that initiated an intent.

dimension

first_event_for_user

first_event_for_user

Indicates if this is the first event recorded for the user.

dimension

hours_from_last_attributed_touch_to_event

hours_from_last_attributed_touch_to_event

The number of hours between the last attributed touch and the event.

dimension

id

id

Unique identifier for the event record.

metric

install_activity_timestamp

install_activity_timestamp

The Unix timestamp of the install activity.

metric

install_activity_touch_data_tilde_advertising_partner_name

install_activity_touch_data_tilde_advertising_partner_name

The name of the advertising partner for the install activity touch.

dimension

install_activity_touch_data_tilde_campaign

install_activity_touch_data_tilde_campaign

The campaign name for the install activity touch.

dimension

last_attributed_touch_data_custom_fields

last_attributed_touch_data_custom_fields

Custom fields associated with the last attributed touch.

dimension

last_attributed_touch_data_dollar_3p

last_attributed_touch_data_dollar_3p

The third-party advertising partner associated with the last attributed touch.

dimension

last_attributed_touch_data_plus_current_feature

last_attributed_touch_data_plus_current_feature

The current Branch feature associated with the last attributed touch.

dimension

last_attributed_touch_data_plus_touch_id

last_attributed_touch_data_plus_touch_id

The unique ID for the last attributed touchpoint.

metric

last_attributed_touch_data_plus_via_features

last_attributed_touch_data_plus_via_features

An array of Branch features through which the last attributed touch occurred.

dimension

last_attributed_touch_data_plus_web_format

last_attributed_touch_data_plus_web_format

The web format associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_ad_id

last_attributed_touch_data_tilde_ad_id

The ID of the ad associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_ad_name

last_attributed_touch_data_tilde_ad_name

The name of the ad associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_ad_set_id

last_attributed_touch_data_tilde_ad_set_id

The ID of the ad set associated with the last attributed touch.

metric

last_attributed_touch_data_tilde_ad_set_name

last_attributed_touch_data_tilde_ad_set_name

The name of the ad set associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_advertising_account_id

last_attributed_touch_data_tilde_advertising_account_id

The ID of the advertising account associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_advertising_account_name

last_attributed_touch_data_tilde_advertising_account_name

The name of the advertising account associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_advertising_partner_id

last_attributed_touch_data_tilde_advertising_partner_id

The ID of the advertising partner associated with the last attributed touch.

metric

last_attributed_touch_data_tilde_advertising_partner_name

last_attributed_touch_data_tilde_advertising_partner_name

The name of the advertising partner associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_agency

last_attributed_touch_data_tilde_agency

The agency associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_agency_id

last_attributed_touch_data_tilde_agency_id

The ID of the agency associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_banner_dimensions

last_attributed_touch_data_tilde_banner_dimensions

The dimensions of the banner ad associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_branch_ad_format

last_attributed_touch_data_tilde_branch_ad_format

The Branch ad format associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_campaign

last_attributed_touch_data_tilde_campaign

The name of the campaign associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_campaign_id

last_attributed_touch_data_tilde_campaign_id

The ID of the campaign associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_campaign_type

last_attributed_touch_data_tilde_campaign_type

The type of campaign associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_channel

last_attributed_touch_data_tilde_channel

The channel associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_creative_id

last_attributed_touch_data_tilde_creative_id

The ID of the creative associated with the last attributed touch.

metric

last_attributed_touch_data_tilde_creative_name

last_attributed_touch_data_tilde_creative_name

The name of the creative associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_ad_name

last_attributed_touch_data_tilde_customer_ad_name

The customer-defined ad name associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_ad_set_name

last_attributed_touch_data_tilde_customer_ad_set_name

The customer-defined ad set name associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_campaign

last_attributed_touch_data_tilde_customer_campaign

The customer-defined campaign name associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_keyword

last_attributed_touch_data_tilde_customer_keyword

The customer-defined keyword associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_placement

last_attributed_touch_data_tilde_customer_placement

The customer-defined placement associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_secondary_publisher

last_attributed_touch_data_tilde_customer_secondary_publisher

The customer-defined secondary publisher associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_customer_sub_site_name

last_attributed_touch_data_tilde_customer_sub_site_name

The customer-defined sub site name associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_external_touch_id

last_attributed_touch_data_tilde_external_touch_id

The external ID of the touchpoint that was last attributed.

dimension

last_attributed_touch_data_tilde_feature

last_attributed_touch_data_tilde_feature

The Branch feature associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_id

last_attributed_touch_data_tilde_id

The unique ID for the last attributed touch data record.

metric

last_attributed_touch_data_tilde_journey_id

last_attributed_touch_data_tilde_journey_id

The ID of the journey associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_journey_name

last_attributed_touch_data_tilde_journey_name

The name of the journey associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_keyword

last_attributed_touch_data_tilde_keyword

The keyword associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_keyword_id

last_attributed_touch_data_tilde_keyword_id

The ID of the keyword associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_optimization_model

last_attributed_touch_data_tilde_optimization_model

The optimization model used for the last attributed touch.

dimension

last_attributed_touch_data_tilde_placement

last_attributed_touch_data_tilde_placement

The placement of the ad associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_placement_id

last_attributed_touch_data_tilde_placement_id

The ID of the placement associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_secondary_ad_format

last_attributed_touch_data_tilde_secondary_ad_format

The secondary ad format associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_secondary_publisher

last_attributed_touch_data_tilde_secondary_publisher

The secondary publisher associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_secondary_publisher_id

last_attributed_touch_data_tilde_secondary_publisher_id

The ID of the secondary publisher associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_stage

last_attributed_touch_data_tilde_stage

The stage of the marketing funnel associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_sub_site_name

last_attributed_touch_data_tilde_sub_site_name

The sub-site name associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_tags

last_attributed_touch_data_tilde_tags

An array of tags associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_technology_partner

last_attributed_touch_data_tilde_technology_partner

The technology partner associated with the last attributed touch.

dimension

last_attributed_touch_data_tilde_view_id

last_attributed_touch_data_tilde_view_id

The ID of the view associated with the last attributed touch.

metric

last_attributed_touch_data_tilde_view_name

last_attributed_touch_data_tilde_view_name

The name of the view associated with the last attributed touch.

dimension

last_attributed_touch_timestamp

last_attributed_touch_timestamp

The Unix timestamp of the last attributed marketing touchpoint before the event.

metric

last_attributed_touch_timestamp_iso

last_attributed_touch_timestamp_iso

The ISO 8601 formatted timestamp of the last attributed marketing touchpoint before the event.

dimension

last_attributed_touch_type

last_attributed_touch_type

The type of the last attributed marketing touchpoint.

dimension

last_cta_view_data_custom_fields

last_cta_view_data_custom_fields

Custom fields associated with the last Call-to-Action (CTA) view.

dimension

last_cta_view_data_dollar_3p

last_cta_view_data_dollar_3p

The third-party ad partner associated with the last CTA view.

dimension

last_cta_view_data_plus_touch_id

last_cta_view_data_plus_touch_id

The unique ID for the last CTA view touchpoint.

dimension

last_cta_view_data_plus_via_features

last_cta_view_data_plus_via_features

An array of Branch features through which the last CTA view occurred.

dimension

last_cta_view_data_plus_web_format

last_cta_view_data_plus_web_format

The web format associated with the last CTA view.

dimension

last_cta_view_data_tilde_ad_id

last_cta_view_data_tilde_ad_id

The ID of the ad associated with the last CTA view.

dimension

last_cta_view_data_tilde_ad_name

last_cta_view_data_tilde_ad_name

The name of the ad associated with the last CTA view.

dimension

last_cta_view_data_tilde_ad_set_id

last_cta_view_data_tilde_ad_set_id

The ID of the ad set associated with the last CTA view.

dimension

last_cta_view_data_tilde_ad_set_name

last_cta_view_data_tilde_ad_set_name

The name of the ad set associated with the last CTA view.

dimension

last_cta_view_data_tilde_advertising_partner_name

last_cta_view_data_tilde_advertising_partner_name

The name of the advertising partner associated with the last CTA view.

dimension

last_cta_view_data_tilde_agency

last_cta_view_data_tilde_agency

The agency associated with the last CTA view.

dimension

last_cta_view_data_tilde_banner_dimensions

last_cta_view_data_tilde_banner_dimensions

The dimensions of the banner ad associated with the last CTA view.

dimension

last_cta_view_data_tilde_branch_ad_format

last_cta_view_data_tilde_branch_ad_format

The Branch ad format associated with the last CTA view.

dimension

last_cta_view_data_tilde_campaign

last_cta_view_data_tilde_campaign

The campaign name associated with the last CTA view.

dimension

last_cta_view_data_tilde_campaign_id

last_cta_view_data_tilde_campaign_id

The ID of the campaign associated with the last CTA view.

dimension

last_cta_view_data_tilde_campaign_type

last_cta_view_data_tilde_campaign_type

The type of campaign associated with the last CTA view.

dimension

last_cta_view_data_tilde_channel

last_cta_view_data_tilde_channel

The channel associated with the last CTA view.

dimension

last_cta_view_data_tilde_creative_id

last_cta_view_data_tilde_creative_id

The ID of the creative associated with the last CTA view.

dimension

last_cta_view_data_tilde_creative_name

last_cta_view_data_tilde_creative_name

The name of the creative associated with the last CTA view.

dimension

last_cta_view_data_tilde_external_touch_id

last_cta_view_data_tilde_external_touch_id

The external ID of the touchpoint that was the last CTA view.

dimension

last_cta_view_data_tilde_feature

last_cta_view_data_tilde_feature

The Branch feature associated with the last CTA view.

dimension

last_cta_view_data_tilde_id

last_cta_view_data_tilde_id

The unique ID for the last CTA view data record.

metric

last_cta_view_data_tilde_keyword_id

last_cta_view_data_tilde_keyword_id

The ID of the keyword associated with the last CTA view.

dimension

last_cta_view_data_tilde_optimization_model

last_cta_view_data_tilde_optimization_model

The optimization model used for the last CTA view.

dimension

last_cta_view_data_tilde_placement

last_cta_view_data_tilde_placement

The placement of the ad associated with the last CTA view.

dimension

last_cta_view_data_tilde_secondary_ad_format

last_cta_view_data_tilde_secondary_ad_format

The secondary ad format associated with the last CTA view.

dimension

last_cta_view_data_tilde_secondary_publisher

last_cta_view_data_tilde_secondary_publisher

The secondary publisher associated with the last CTA view.

dimension

last_cta_view_data_tilde_stage

last_cta_view_data_tilde_stage

The stage of the marketing funnel associated with the last CTA view.

dimension

last_cta_view_data_tilde_tags

last_cta_view_data_tilde_tags

An array of tags associated with the last CTA view.

dimension

last_cta_view_data_tilde_technology_partner

last_cta_view_data_tilde_technology_partner

The technology partner associated with the last CTA view.

dimension

last_cta_view_timestamp

last_cta_view_timestamp

The Unix timestamp of the last Call-to-Action (CTA) view.

metric

last_cta_view_timestamp_iso

last_cta_view_timestamp_iso

The ISO 8601 formatted timestamp of the last Call-to-Action (CTA) view.

dimension

minutes_from_last_attributed_touch_to_event

minutes_from_last_attributed_touch_to_event

The number of minutes between the last attributed touch and the event.

dimension

name

name

The name of the event, based on the selected topic.

dimension

organization_id

organization_id

Unique identifier for the Branch organization.

dimension

organization_name

organization_name

The name of the Branch organization.

dimension

origin

origin

The origin of the event.

dimension

reengagement_activity_attributed

reengagement_activity_attributed

Indicates if the reengagement activity was attributed.

dimension

referrer_click_timestamp

referrer_click_timestamp

The Unix timestamp of the referrer click.

dimension

seconds_from_install_to_event

seconds_from_install_to_event

The number of seconds from the install to the event.

metric

seconds_from_last_attributed_touch_to_event

seconds_from_last_attributed_touch_to_event

The number of seconds from the last attributed touch to the event.

dimension

seconds_from_last_attributed_touch_to_store_install_begin

seconds_from_last_attributed_touch_to_store_install_begin

The number of seconds from the last attributed touch to the beginning of the store install process.

dimension

site_event_items_count

site_event_items_count

The count of content items associated with the site event.

metric

store_install_begin_timestamp

store_install_begin_timestamp

The Unix timestamp when the store install process began.

dimension

timestamp

timestamp

The Unix timestamp when Branch received the event data.

dimension

timestamp_iso

timestamp_iso

The ISO 8601 formatted timestamp when Branch received the event data.

dimension

user_data_aaid

user_data_aaid

The Google Advertising ID (AAID) for Android devices.

dimension

user_data_android_id

user_data_android_id

The Android device ID.

dimension

user_data_app_package_name

user_data_app_package_name

The package name of the application.

dimension

user_data_app_version

user_data_app_version

The version of the application on the user’s device.

dimension

user_data_brand

user_data_brand

The brand of the user’s device.

dimension

user_data_browser

user_data_browser

The browser used by the user.

dimension

user_data_build

user_data_build

The build number of the user’s device operating system.

dimension

user_data_carrier_name

user_data_carrier_name

The name of the cellular carrier of the user’s device.

dimension

user_data_cpu_type

user_data_cpu_type

The CPU type of the user’s device.

dimension

user_data_cross_platform_id

user_data_cross_platform_id

A cross-platform identifier for the user.

dimension

user_data_developer_identity

user_data_developer_identity

The developer identity associated with the user.

metric

user_data_device_locale

user_data_device_locale

The locale setting of the user’s device.

dimension

user_data_device_type

user_data_device_type

The type of device the user is using.

dimension

user_data_environment

user_data_environment

The environment (e.g., test, live) where the event occurred.

dimension

user_data_geo_city_code

user_data_geo_city_code

The city code derived from the user’s geographical location.

metric

user_data_geo_city_en

user_data_geo_city_en

The city name derived from the user’s geographical location.

dimension

user_data_geo_country_code

user_data_geo_country_code

The country code derived from the user’s geographical location.

dimension

user_data_geo_country_en

user_data_geo_country_en

The country name derived from the user’s geographical location.

dimension

user_data_geo_dma_code

user_data_geo_dma_code

The Designated Market Area (DMA) code derived from the user’s geographical location.

metric

user_data_geo_lat

user_data_geo_lat

The latitude coordinate derived from the user’s geographical location.

metric

user_data_geo_lon

user_data_geo_lon

The longitude coordinate derived from the user’s geographical location.

metric

user_data_geo_postal_code

user_data_geo_postal_code

The postal code derived from the user’s geographical location.

dimension

user_data_http_referrer

user_data_http_referrer

The HTTP referrer URL that led to the event.

dimension

user_data_idfa

user_data_idfa

The Identifier for Advertisers (IDFA) for iOS devices.

dimension

user_data_idfv

user_data_idfv

The Identifier for Vendors (IDFV) for iOS devices.

dimension

user_data_installer_package_name

user_data_installer_package_name

dimension

user_data_internet_connection_type

user_data_internet_connection_type

The type of internet connection used by the user’s device.

dimension

user_data_ip

user_data_ip

The IP address of the user’s device.

dimension

user_data_is_jailbroken

user_data_is_jailbroken

Indicates whether the user’s device is jailbroken (for iOS) or rooted (for Android).

dimension

user_data_kindle_id

user_data_kindle_id

The unique identifier for a Kindle device.

dimension

user_data_language

user_data_language

The language setting of the user’s device.

dimension

user_data_limit_ad_tracking

user_data_limit_ad_tracking

Indicates whether the user has enabled Limit Ad Tracking (LAT) on their device, which restricts advertisers from tracking their activity.

dimension

user_data_model

user_data_model

The model name of the user’s device.

dimension

user_data_os

user_data_os

The operating system of the user’s device.

dimension

user_data_os_version

user_data_os_version

The operating system version of the user’s device.

dimension

user_data_os_version_android

user_data_os_version_android

The Android operating system version of the user’s device.

dimension

user_data_past_cross_platform_ids

user_data_past_cross_platform_ids

A list of past cross-platform identifiers associated with the user.

dimension

user_data_platform

user_data_platform

The platform of the user’s device, e.g., iOS, Android, Web.

dimension

user_data_prob_cross_platform_ids

user_data_prob_cross_platform_ids

A list of probabilistic cross-platform identifiers associated with the user.

dimension

user_data_screen_height

user_data_screen_height

The height of the user’s device screen in pixels.

metric

user_data_screen_width

user_data_screen_width

The width of the user’s device screen in pixels.

metric

user_data_sdk_version

user_data_sdk_version

The version of the Branch SDK integrated into the application.

dimension

user_data_user_agent

user_data_user_agent

The User-Agent string of the browser or application used by the user, providing details about the operating system, browser, and device.

dimension

user_data_windows_aid

user_data_windows_aid

The Advertising ID (AID) for Windows devices.

dimension