Branch

Branch is a mobile attribution and analytics platform that helps organizations measure, optimize, and manage app growth across channels.

Branch integration replicates data using the Branch Custom Export API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To set up your Branch account, you need:

A Branch account with access to the app you want to replicate.
An access token with sufficient permissions. To ensure all tables replicate successfully, the token's user must have Export Access and Sensitive data view access enabled. Verify or update these settings in Configurations > Security & Access > Team.
A custom export dashboard created in the Branch portal. The Custom Export API requires a dashboard to be set up before use. For instructions, see Prerequisites — API access in the Branch documentation.

To find your Branch App ID and access token:

Branch App ID: In the Branch portal, navigate to Configurations > App Settings > General.
Access Token: In the Branch portal, navigate to Configurations > Security & Access > Credentials.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Branch App ID	App ID.
Access Token	Access token.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

Depending on your destination, table and column names may not appear as they are outlined below.

cost

The cost table contains ad cost data for your Branch app. This is a non-event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_branch_cta_view

The eo_branch_cta_view table contains Branch call-to-action view events for your app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_branch_cta_view_blocked

The eo_branch_cta_view_blocked table contains blocked Branch call-to-action view events for your app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_click

The eo_click table contains ad click events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_click_blocked

The eo_click_blocked table contains blocked ad click events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_commerce_event

The eo_commerce_event table contains commerce (purchase) events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_commerce_event_blocked

The eo_commerce_event_blocked table contains blocked commerce events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_content_event

The eo_content_event table contains content interaction events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_content_event_blocked

The eo_content_event_blocked table contains blocked content interaction events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_custom_event

The eo_custom_event table contains custom events defined in your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_custom_event_blocked

The eo_custom_event_blocked table contains blocked custom events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_dismissal

The eo_dismissal table contains banner and interstitial dismissal events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_impression

The eo_impression table contains ad impression events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_impression_blocked

The eo_impression_blocked table contains blocked ad impression events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_install

The eo_install table contains app install events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_install_blocked

The eo_install_blocked table contains blocked app install events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_open

The eo_open table contains app open events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_open_blocked

The eo_open_blocked table contains blocked app open events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_pageview

The eo_pageview table contains web page view events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_pageview_blocked

The eo_pageview_blocked table contains blocked web page view events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_reinstall

The eo_reinstall table contains app reinstall events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_reinstall_blocked

The eo_reinstall_blocked table contains blocked app reinstall events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_san_touch

The eo_san_touch table contains self-attributing network touch events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_user_lifecycle_event

The eo_user_lifecycle_event table contains user lifecycle events (for example, registrations and logins) for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_user_lifecycle_event_blocked

The eo_user_lifecycle_event_blocked table contains blocked user lifecycle events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_web_session_start

The eo_web_session_start table contains web session start events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_web_session_start_blocked

The eo_web_session_start_blocked table contains blocked web session start events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_web_to_app_auto_redirect

The eo_web_to_app_auto_redirect table contains web-to-app auto-redirect events for your Branch app. This is a core event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

eo_web_to_app_auto_redirect_blocked

The eo_web_to_app_auto_redirect_blocked table contains blocked web-to-app auto-redirect events for your Branch app. This is a blocked and fraud event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

skadnetwork_valid_messages

The skadnetwork_valid_messages table contains valid SKAdNetwork postback messages (iOS) for your Branch app. This is a non-event table.

Replication Method	CDC
Primary Key	id
Useful links	Branch API reference

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here