Branch

The Branch integration is available on the Enterprise plan.

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.

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.

User mapping

Radar deviceId maps to idfv for iOS devices and android_id for Android devices in Branch. For web devices, set Radar metadata.branchFingerprintId to the Branch Browser Fingerprint Id.

branch.getBrowserFingerprintId(function(err, data) {
    Radar.setMetadata({ 'branchFingerprintId': data });
});

Event mapping

Radar Event	Context Type	Branch Event
user.entered_geofence	Geofences	entered_geofence
user.exited_geofence	Geofences	exited_geofence
user.dwelled_in_geofence	Geofences	dwelled_in_geofence
user.entered_place	Places	entered_place
user.exited_place	Places	exited_place
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
user.started_trip	Trip Tracking	started_trip
user.updated_trip	Trip Tracking	updated_trip
user.approaching_trip_destination	Trip Tracking	approaching_trip_destination
user.arrived_at_trip_destination	Trip Tracking	arrived_at_trip_destination
user.stopped_trip	Trip Tracking	stopped_trip
user.entered_beacon	Beacons	entered_beacon
user.exited_beacon	Beacons	exited_beacon

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"
foreground	foreground	boolean	true

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
foreground	foreground	boolean	true

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"

dwelled_in_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)	5
foreground	foreground	boolean	true

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"
foreground	foreground	boolean	true

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
foreground	foreground	boolean	true

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"(/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_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"
foreground	foreground	boolean	true

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"
foreground	foreground	boolean	true

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"
foreground	foreground	boolean	true

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"
foreground	foreground	boolean	true

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"
foreground	foreground	boolean	true

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"
foreground	foreground	boolean	true

started_trip

Radar Event Attribute	Branch Event Property	Type	Example Value
trip.externalId	trip_external_id	string	"299"
trip.metadata[{key}]	trip_metadata_{key}	type	{value}
trip.destinationGeofenceTag	trip_destination_geofence_tag	string	"store"
trip.destinationGeofenceExternalId	trip_destination_geofence_external_id	string	"123"
foreground	foreground	boolean	true

updated_trip

Radar Event Attribute	Branch Event Property	Type	Example Value
trip.externalId	trip_external_id	string	"299"
trip.metadata[{key}]	trip_metadata_{key}	type	{value}
trip.destinationGeofenceTag	trip_destination_geofence_tag	string	"store"
trip.destinationGeofenceExternalId	trip_destination_geofence_external_id	string	"123"
foreground	foreground	boolean	true

approaching_trip_destination

Radar Event Attribute	Branch Event Property	Type	Example Value
trip.externalId	trip_external_id	string	"299"
trip.metadata[{key}]	trip_metadata_{key}	type	{value}
trip.destinationGeofenceTag	trip_destination_geofence_tag	string	"store"
trip.destinationGeofenceExternalId	trip_destination_geofence_external_id	string	"123"
foreground	foreground	boolean	true

arrived_at_trip_destination

Radar Event Attribute	Branch Event Property	Type	Example Value
trip.externalId	trip_external_id	string	"299"
trip.metadata[{key}]	trip_metadata_{key}	type	{value}
trip.destinationGeofenceTag	trip_destination_geofence_tag	string	"store"
trip.destinationGeofenceExternalId	trip_destination_geofence_external_id	string	"123"
foreground	foreground	boolean	true

stopped_trip

Radar Event Attribute	Branch Event Property	Type	Example Value
trip.externalId	trip_external_id	string	"299"
trip.metadata[{key}]	trip_metadata_{key}	type	{value}
trip.destinationGeofenceTag	trip_destination_geofence_tag	string	"store"
trip.destinationGeofenceExternalId	trip_destination_geofence_external_id	string	"123"
foreground	foreground	boolean	true

entered_beacon

Radar Event Attribute	Branch Event Property	Type	Example Value
beacon._id	beacon_id	string	"5b2c0906f5874b001aecfd8f"
beacon.description	beacon_description	string	"Store #123 - Drive-Thru"
beacon.tag	beacon_tag	string	"drive-thru"
beacon.externalId	beacon_external_id	string	"123"
beacon.metadata[{key}]	beacon_metadata_{key}	type	{value}
confidence	confidence	string	"high"
foreground	foreground	boolean	true

exited_beacon

Radar Event Attribute	Branch Event Property	Type	Example Value
beacon._id	beacon_id	string	"5b2c0906f5874b001aecfd8f"
beacon.description	beacon_description	string	"Store #123 - Drive-Thru"
beacon.tag	beacon_tag	string	"drive-thru"
beacon.externalId	beacon_external_id	string	"123"
beacon.metadata[{key}]	beacon_metadata_{key}	type	{value}
confidence	confidence	string	"high"
duration	duration	number (minutes)	1.42
foreground	foreground	boolean	true