Branch

Radar can send events to Branch.

Use the Branch integration to attribute offline actions to online campaigns and measure the ROI of location-based features.

The Branch integration is available on the Team plan or higher.

Configuration

On the Branch Account Settings page under Profile, copy your Branch key.

Then, on the Radar Integrations page under Branch, set Enabled to Yes and paste your key. Note that you can set separate keys for the Test and Live environments.

Whenever events are generated, Radar will send custom events to Branch.

Radar sends adId (iOS IDFA, Android advertising ID) and deviceId (iOS IDFV, Android ID) to Branch. On SDK v3 and higher, you must manually enable adId collection. For example, on iOS:

Radar.setAdIdEnabled(true)

User mapping

Radar deviceId maps to idfv for iOS devices and android_id for Android devices in Branch.

Event mapping

Radar Event Context Type Branch Event
user.entered_geofence Geofences entered_geofence
user.exited_geofence Geofences exited_geofence
user.entered_place Places entered_place
user.exited_place Places exited_place
user.entered_home Insights entered_home
user.exited_home Insights exited_home
user.entered_office Insights entered_office
user.exited_office Insights exited_office
user.started_traveling Insights started_traveling
user.stopped_traveling Insights stopped_traveling
user.entered_region_country Regions entered_country
user.exited_region_country Regions exited_country
user.entered_region_state Regions entered_state
user.exited_region_state Regions exited_state
user.entered_region_dma Regions entered_dma
user.exited_region_dma Regions exited_dma

entered_geofence

Radar Event Field Branch Event Property Type Example Value
geofence._id geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description geofence_description string "Store #123"
geofence.tag geofence_tag string "store"
geofence.externalId geofence_external_id string "123"
geofence.metadata[{key}] geofence_metadata_{key} {type} {value}
confidence confidence string "high"

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field Branch Event Property Type Example Value
country.code country_code string "US"
country.name country_name string "United States"
state.code state_code string "MD"
state.name state_name string "Maryland"
dma.code dma_code string "26"
dma.name dma_name string "Baltimore"
postalCode.code postal_code string "21014"

exited_geofence

Radar Event Field Branch Event Property Type Example Value
geofence._id geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description geofence_description string "Store #123"
geofence.tag geofence_tag string "store"
geofence.externalId geofence_external_id string "123"
geofence.metadata[{key}] geofence_metadata_{key} {type} {value}
confidence confidence string "high"
duration duration number (minutes) 42.1

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field Branch Event Property Type Example Value
country.code country_code string "US"
country.name country_name string "United States"
state.code state_code string "MD"
state.name state_name string "Maryland"
dma.code dma_code string "26"
dma.name dma_name string "Baltimore"
postalCode.code postal_code string "21014"

entered_place

Radar Event Field Branch Event Property Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Starbucks"
place.chain.slug place_chain_id string "starbucks"
place.chain.name place_chain_name string "Starbucks"
place.chain.externalId place_chain_external_id string "123"
place.chain.metadata[{key}] place_chain_metadata_{key} {type} {value}
place.categories place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence confidence string "high"

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field Branch Event Property Type Example Value
country.code country_code string "US"
country.name country_name string "United States"
state.code state_code string "MD"
state.name state_name string "Maryland"
dma.code dma_code string "26"
dma.name dma_name string "Baltimore"
postalCode.code postal_code string "21014"

exited_place

Radar Event Field Branch Event Property Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Starbucks"
place.chain.slug place_chain_id string "starbucks"
place.chain.name place_chain_name string "Starbucks"
place.chain.externalId place_chain_external_id string "123"
place.chain.metadata[{key}] place_chain_metadata_{key} {type} {value}
place.categories place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence confidence string "high"
duration duration number (minutes) 42.1

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field Branch Event Property Type Example Value
country.code country_code string "US"
country.name country_name string "United States"(/documentation/regions)
state.code state_code string "MD"
state.name state_name string "Maryland"
dma.code dma_code string "26"
dma.name dma_name string "Baltimore"
postalCode.code postal_code string "21014"

entered_home

Radar Event Field Branch Event Property Type Example Value
confidence confidence string "high"

exited_home

Radar Event Field Branch Event Property Type Example Value
confidence confidence string "high"

entered_office

Radar Event Field Branch Event Property Type Example Value
confidence confidence string "high"

exited_office

Radar Event Field Branch Event Property Type Example Value
confidence confidence string "high"

started_traveling

Radar Event Field Branch Event Property Type Example Value
confidence confidence string "high"

stopped_traveling

Radar Event Field Branch Event Property Type Example Value
confidence confidence string "high"

entered_country

Radar Event Attribute Branch Event Property Type Example Value
region.code region_code string "US"
region.name region_name string "United States"
confidence confidence string "high"

exited_country

Radar Event Attribute Branch Event Property Type Example Value
region.code region_code string "US"
region.name region_name string "United States"
confidence confidence string "high"

entered_state

Radar Event Attribute Branch Event Property Type Example Value
region.code region_code string "MD"
region.name region_name string "Maryland"
confidence confidence string "high"

exited_state

Radar Event Attribute Branch Event Property Type Example Value
region.code region_code string "MD"
region.name region_name string "Maryland"
confidence confidence string "high"

entered_dma

Radar Event Attribute Branch Event Property Type Example Value
region.code region_code string "26"
region.name region_name string "Baltimore"
confidence confidence string "high"

exited_dma

Radar Event Attribute Branch Event Property Type Example Value
region.code region_code string "26"
region.name region_name string "Baltimore"
confidence confidence string "high"