Branch Attribution API (`branch-io/v1`)

operated by: Branch Metrics, Inc. (get company information on datarequests.org, go to tracker entry in the Exodus database)

The Branch Attribution API is used for “deep linking and session attribution. […] Every time the API is called, it will track an INSTALL, REINSTALL, or OPEN event in Branch and return deep link data in the response if the session is attributed.”

It can also track “additional downstream conversion events” like PURCHASE.

Endpoint URLs

These are URLs or regexes of endpoints the tracker sends data to. We use these to determine which adapter to apply to a request. Some trackers use the same endpoint for several formats. In this case we use additional logic to match the adapter to the request, refer to the code for more information.

/^https:\/\/api2?\.branch\.io\/v1\/install$/
/^https:\/\/api2?\.branch\.io\/v1\/open$/
/^https:\/\/api2?\.branch\.io\/v1\/close$/
/^https:\/\/api2?\.branch\.io\/v1\/profile$/
/^https:\/\/api2?\.branch\.io\/v1\/logout$/

Decoding steps

Every tracking library has its own way of transmitting tracking data, often even several. They are regularly pretty convoluted, nested encoding schemes. Because of that, the adapter needs to decode the request information into a consistent format. We try to keep keys and paths intact, but the structure results from our decoding. All steps used in the decoding for this adapter are documented here.

Description

Parse the request body as JSON. Store that in the result for the request body.

Pseudo code

1res.body = parseJson(body)

Observed data transmissions

This is data that we observed being transmitted by this tracker. Not every request contains all of this data. The context of the data describes where we found the data in the request, the path describes the location of the data in the decoded request. The examples are a selection of observed values.

Property	Context	Path	Examples of observed values
Device advertising ID (GAID/IDFA)	body	`google_advertising_id`	`827d8162-0e1c-48cd-892e-4abd3df95ba8` `ea70edc1-ac05-481c-8d2a-66b1be496a7e` `830ec0b3-e94e-43e5-8722-a3a428af37bb` `49b61a9c-cece-4300-b52e-26840e4c258e` `fffe8a97-a504-4d14-89ab-c2025fbaf065`
Device advertising ID (GAID/IDFA)	body	`advertising_ids.aaid`	`827d8162-0e1c-48cd-892e-4abd3df95ba8` `ea70edc1-ac05-481c-8d2a-66b1be496a7e` `830ec0b3-e94e-43e5-8722-a3a428af37bb` `49b61a9c-cece-4300-b52e-26840e4c258e` `fffe8a97-a504-4d14-89ab-c2025fbaf065`
App ID	body	`cd.pn`	`com.money91` `com.emdigital.jillianmichaels` `com.mapmywalk.android2` `com.expedia.bookings` `com.balaji.alt`
App ID	body	`ios_bundle_id`	`io.metamask.MetaMask` `com.fittastetic.fitnessrecipes` `app.cabuu.vokabeltrainer` `co.alphaexploration.clubhouse` `com.kik.chat`
App version	body	`app_version`	`2.3.25-mall91-Hello-2021-` `4.0.2` `6.4.2` `1.0.2` `21.1.0`
Architecture	body	`cpu_type`	`x86_64` `armv7l` `aarch64` `16777228` `i686`
Carrier	body	`device_carrier`	`Android` `o2-de` `T-Mobile`
Country	body	`country`	`US` `DE` `GB`
Developer-scoped device ID (IDFV/ASID/ANDROID_ID)	body	`ios_vendor_id`	`F0F39125-DA58-47CD-A8B1-442BAA23B122` `0A76B352-A45D-485E-82C0-78ECC3B28E8D` `2BA51228-EEC9-4A13-88F2-662C773F4E4F` `2795F07D-E765-4C30-AE62-8169263C00B5` `61311AC2-A1B8-4C73-BB98-17B5E8CE042C`
Unique device ID	body	`hardware_id`	`f6c6c6054f4277e1` `bae047af5c18a8c0` `c368c0e9ac6ddcd4` `68a7358abdd48879` `d1c45accc2c9df9a`
	body	`metadata.device_id`	`247df20b-c12d-34e3-95ca-de106121f412` `8d7881041169e2474ea24f2d337b2eea`
	body	`metadata.$google_analytics_client_id`	`49C6ABCE-1C65-4083-B6E2-53E98A8A4453` `C42B71E1-92F3-4E1B-8ADC-878CF458BA90`
	body	`device_fingerprint_id`	`877232428372316972` `1037005301759792361` `1038868524162870422` `1039056225142816903` `1039515475171464293`
Unique installation ID	body	`metadata.$braze_install_id`	`801583fe-b4b6-4d42-a5ae-3d50c5953f84` `7be79989-f26a-407d-b2d6-cab0f80b3ab1` `888a915d-bb65-4b40-b648-3cd1cb38745e` `00d8199c-bb67-4367-b235-197a49fac3a7`
Language	body	`language`	`en` `fa` `de` `ar`
Language	body	`locale`	`en_US` `en_` `en_DE` `de_DE` `en_GB`
Local IP address(es)	body	`local_ip`	`10.0.2.15` `10.0.0.22` `10.0.2.18` `169.254.170.127` `169.254.103.80`
Manufacturer	body	`brand`	`Google` `Apple`
Model	body	`model`	`sdk_gphone_x86_64_arm64` `iPhone9,3` `iPhone10,4` `sdk_gphone_x86_64` `iPhone10,6`
Network connection type	body	`connection_type`	`wifi` `mobile`
OS name	body	`os`	`Android` `iOS`
OS version	body	`os_version_android`	`11` `13`
OS version	body	`os_version`	`30` `14.8` `14.5.1` `33` `15.6.1`
Other unique identifier	body	`metadata.uuid`	`b9c2c9606bbb439abf6c437663221f15` `ios_d74ad2d07c9c460d91b806ebde26f7ff_sara` `ios_c6ae5cd0799e48f3b7ed1fc05bf1979f_sara` `ios_746f759635fc4e07adb5404d1c82484a_sara` `android_eed9caa0-518e-424e-b861-cd6357905f25_sara`
Other unique identifier	body	`UDID`	`85c0a6d3-2349-ee7d-3e60-bdf8a0dd41e7`
Screen height	body	`screen_height`	`2392` `1334` `750` `2148` `1080`
Screen width	body	`screen_width`	`1440` `750` `1334` `1080` `2148`
Tracker SDK version	body	`sdk`	`android4.4.0` `android3.2.0` `android5.0.4` `android5.0.3` `android3.0.4`
User agent	body	`user_agent`	`Mozilla/5.0 (iPhone; CPU iPhone OS 14_8 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148` `Mozilla/5.0 (iPhone; CPU iPhone OS 14_8 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 EmbeddedInApp` `Guide MICHELIN /7.13 (iOS 14_8; iPhone) MOBILE_APP` `Mozilla/5.0 (iPhone; CPU iPhone OS 14_5_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148` `Mozilla/5.0 (iPhone; CPU iPhone OS 15_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148`
Unique user ID	body	`metadata.$marketing_cloud_visitor_id`	`29734408328804945661443970805804850962` `77110713079282879656006300137322319642` `02870210764132000548517218483593986636` `16769637078768952587997860967192946285` `70085465652448540340149301186454436255`
	body	`metadata.$mixpanel_distinct_id`	`bd5223d4-af70-4e5c-b83f-e435f6ce06bc` `d7068976-3382-4eac-ac2d-33395f25cb0b` `425C3FBF-C742-4F91-998C-DB18ED6834CB` `c5febc13-fdb5-485d-9018-eb18c5a6e197` `$device:1cf0e7bd-e965-4725-b14a-2fe9014e667c`
	body	`metadata.$segment_anonymous_id`	`c10b8dcc-f7c4-4b2a-a71a-3bf285003405` `C012B3D5-A910-4866-82D6-E60A450EEEC0` `49ACB225-5512-47C2-A693-D3B9FA135F01`
	body	`metadata.user_id`	`abd05654-3888-4247-ad58-980dd113a551` `BF8B3275-8C61-4911-B31A-8BCB0FDB72A0` `13459393` `0094286f-27f0-442a-b70d-0347933e30dc`
	body	`identity`	`005b005a-6404-40a0-a248-01fade7bdb9b` `96B9FAB0-9947-47A3-B06B-C0D638E5437D` `0f499fca-427b-4e2f-889e-a50b2f37dafc` `212056` `93551974`
	body	`identity_id`	`879862562383384377` `882655974405801879` `1038554315843730811` `1038554317303962192` `1038868524457035429`

References

Documentation for google_advertising_id: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for advertising_ids.aaid: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for app_version: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for ios_vendor_id: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for hardware_id: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for metadata.$google_analytics_client_id: https://help.branch.io/partners-portal/docs/google-analytics
Documentation for metadata.$braze_install_id: https://help.branch.io/partners-portal/docs/braze
Documentation for local_ip: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for os: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for os_version: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for screen_height: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for screen_width: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for user_agent: https://help.branch.io/developers-hub/reference/attribution-api
Documentation for metadata.user_id: https://help.branch.io/using-branch/docs/advertising-identifiers-for-attribution
Documentation for identity: https://help.branch.io/developers-hub/reference/attribution-api

Branch Attribution API (branch-io/v1)

Endpoint URLs

Decoding steps

Observed data transmissions

Branch Attribution API (`branch-io/v1`)