To ensure a smooth transition from TUNE to Branch, a custom export API was built specifically to minimize the number of changes you will need to make when exporting your raw Attribution Analytics data. 

Outlined below is our recommended transition plan which will help you understand both the upcoming process as well as the similarities and differences between the TUNE Export API and the Branch Custom Export API.

Phase 1: Dual API Access

Within the next few weeks you will be given access to the Branch Dashboard. When you receive the login email, you will also receive explicit instructions on how to download your raw TUNE data from the Branch Custom Export API. This new API allows you to export data directly from the Branch system, but using the familiar TUNE field names.

During this stage, we highly recommend you follow the instructions we provide to test out the Branch Custom Export API. You should examine the results from Branch, test pushing the data through your ETL processes, and ensure that all of your systems dependent on this data function as intended.

It is essential that you confirm run test calls using the new Branch Custom Export API during this phase. In the next phase you will no longer be able to download data from TUNE directly as you do now. 

Phase 2: Branch Custom Export API only

After your account has been migrated to the Branch infrastructure, there will no longer be any NEW data in TUNE's systems. All new requests to TUNE are immediately mirrored to Branch who will handle the requests and return a response. Once you receive notification of your final account migration, you must rely on the Branch Custom Export API to export any data moving forward.

In order to access the Branch Custom Export API, simply add the query parameter &branch_redirect=3 to all of your original TUNE export API calls.  Doing so ensure that you are querying Branch for your data and not TUNE.

NOTE: For a limited time (up until late April 2019), you will still be able to export historical data (i.e. data from before the cut over to Branch) directly from TUNE. To access your historical log data stored in TUNE, you will need to change the &branch_redirect query parameter's value from 3 (hit Branch for data) to 0 (hit TUNE for data); &branch_redirect=0.

After that date, the TUNE infrastructure will be shut off and inaccessible.

Phase 3: TUNE Export API Inaccessible 

In April 2019, all TUNE infrastructure will be shut off and historical data will be permanently deleted. At this time, the TUNE Export API will no longer function, and custom requests to pull data cannot be honored.

Your Action Items

We will send instructions for accessing the Branch Custom Export API in a future email. It will involve simply adding an additional query parameter - &branch_redirect - to your existing requests to the TUNE Export API.

  • Phase 1 - Export data via both the TUNE and Branch Export APIs. Compare the data.  Ensure that data returned from the Branch Custom Export API works with your ETL jobs.

  • Phase 2 - Make requests to the Branch Custom Export API for current data following the instructions outlined above.

  • Phase 3 - Specify a timezone in every request. Starting in Phase 3, if you do not specify a timezone when making the request, we will use UTC. More information below.

Small differences

Different behavior when no timezone is specified

By default, if you don't specify a timezone on your Export API request, TUNE will use the user-level timezone. From now through April 2018, while the TUNE infra is still working, we will continue to respect user-level timezones in the Branch Custom Export API. 

However, after we shut off the TUNE infrastructure in late April 2018, if no timezone is specified on the request, we will use UTC as the default timezone. As a result, we highly suggest you add an explicit timezone= query parameter to every Export API request you make.

Discontinued topics

We will not allow exporting event_items as of January 2019. This will be supported in the near future, likely February or March. Please let us know if you make use of event_items and we can discuss possible solutions.

We no longer allow exports of the following infrequently-used tables:

  • updates

  • postbacks

Again, if you make use of these via the API, please reach out to your CSM or our Support team and we can discuss possible solutions.

Field Value Changes

When exporting the following fields, you will notice a difference between the value TUNE provides vs the value Branch provides.

  • Country Name
    • TUNE: Korea - South
    • Branch: Republic of Korea
  • Region Name
    • TUNE: seoul teugbyeoisi
    • Branch: Seoul
  • City Code
    • TUNE: 2261 (Seoul)
    • Branch: 1835848 (Seoul)
  • Language
    • TUNE: ko, ko-KR, en-KR
    • Branch: KO

Discontinued fields

Some fields seem to have very limited value to our customers and as such have been discontinued. Please work with your CSM or our Support team if you have questions about any custom use cases and whether the fields you regularly use will be supported.

SQL filtering

Please rewrite any queries that use the filter query param to make use of the filter_cthulhu query param instead. The older filter query param will no longer be supported. Again, you can reach out to your CSM or our Support team if you have questions about how to rework your filters.

Third Party Access

Any user with access to an account’s API keys will be able to access Branch’s Custom Export API (and thus unfiltered, log-level data). As a result, we would recommend against providing third parties (agencies and ad partners) with the permissions required to view API keys - Sensitive Data and App-Level Settings - during the invitation process.