Skip to main content

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.

User mapping#

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

Event mapping#

Radar EventContext TypeBranch Event
user.entered_geofenceGeofencesentered_geofence
user.exited_geofenceGeofencesexited_geofence
user.entered_placePlacesentered_place
user.exited_placePlacesexited_place
user.entered_homeInsightsentered_home
user.exited_homeInsightsexited_home
user.entered_officeInsightsentered_office
user.exited_officeInsightsexited_office
user.started_travelingInsightsstarted_traveling
user.stopped_travelingInsightsstopped_traveling
user.entered_region_countryRegionsentered_country
user.exited_region_countryRegionsexited_country
user.entered_region_stateRegionsentered_state
user.exited_region_stateRegionsexited_state
user.entered_region_dmaRegionsentered_dma
user.exited_region_dmaRegionsexited_dma

entered_geofence#

Radar Event FieldBranch Event PropertyTypeExample Value
geofence._idgeofence_idstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofence_descriptionstring"Store #123"
geofence.taggeofence_tagstring"store"
geofence.externalIdgeofence_external_idstring"123"
geofence.metadata[{key}]geofence_metadata_{key}{type}{value}
confidenceconfidencestring"high"

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

Radar Event FieldBranch Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

exited_geofence#

Radar Event FieldBranch Event PropertyTypeExample Value
geofence._idgeofence_idstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofence_descriptionstring"Store #123"
geofence.taggeofence_tagstring"store"
geofence.externalIdgeofence_external_idstring"123"
geofence.metadata[{key}]geofence_metadata_{key}{type}{value}
confidenceconfidencestring"high"
durationdurationnumber (minutes)42.1

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

Radar Event FieldBranch Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

entered_place#

Radar Event FieldBranch Event PropertyTypeExample Value
place._idplace_idstring"59302bcf8f27e8a156bd4f91"
place.nameplace_namestring"Starbucks"
place.chain.slugplace_chain_idstring"starbucks"
place.chain.nameplace_chain_namestring"Starbucks"
place.chain.externalIdplace_chain_external_idstring"123"
place.chain.metadata[{key}]place_chain_metadata_{key}{type}{value}
place.categoriesplace_categoriesstring (comma-separated)"food-beverage,cafe,coffee-shop"
confidenceconfidencestring"high"

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

Radar Event FieldBranch Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

exited_place#

Radar Event FieldBranch Event PropertyTypeExample Value
place._idplace_idstring"59302bcf8f27e8a156bd4f91"
place.nameplace_namestring"Starbucks"
place.chain.slugplace_chain_idstring"starbucks"
place.chain.nameplace_chain_namestring"Starbucks"
place.chain.externalIdplace_chain_external_idstring"123"
place.chain.metadata[{key}]place_chain_metadata_{key}{type}{value}
place.categoriesplace_categoriesstring (comma-separated)"food-beverage,cafe,coffee-shop"
confidenceconfidencestring"high"
durationdurationnumber (minutes)42.1

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

Radar Event FieldBranch Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"(/regions)
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

entered_home#

Radar Event FieldBranch Event PropertyTypeExample Value
confidenceconfidencestring"high"

exited_home#

Radar Event FieldBranch Event PropertyTypeExample Value
confidenceconfidencestring"high"

entered_office#

Radar Event FieldBranch Event PropertyTypeExample Value
confidenceconfidencestring"high"

exited_office#

Radar Event FieldBranch Event PropertyTypeExample Value
confidenceconfidencestring"high"

started_traveling#

Radar Event FieldBranch Event PropertyTypeExample Value
confidenceconfidencestring"high"

stopped_traveling#

Radar Event FieldBranch Event PropertyTypeExample Value
confidenceconfidencestring"high"

entered_country#

Radar Event AttributeBranch Event PropertyTypeExample Value
region.coderegion_codestring"US"
region.nameregion_namestring"United States"
confidenceconfidencestring"high"

exited_country#

Radar Event AttributeBranch Event PropertyTypeExample Value
region.coderegion_codestring"US"
region.nameregion_namestring"United States"
confidenceconfidencestring"high"

entered_state#

Radar Event AttributeBranch Event PropertyTypeExample Value
region.coderegion_codestring"MD"
region.nameregion_namestring"Maryland"
confidenceconfidencestring"high"

exited_state#

Radar Event AttributeBranch Event PropertyTypeExample Value
region.coderegion_codestring"MD"
region.nameregion_namestring"Maryland"
confidenceconfidencestring"high"

entered_dma#

Radar Event AttributeBranch Event PropertyTypeExample Value
region.coderegion_codestring"26"
region.nameregion_namestring"Baltimore"
confidenceconfidencestring"high"

exited_dma#

Radar Event AttributeBranch Event PropertyTypeExample Value
region.coderegion_codestring"26"
region.nameregion_namestring"Baltimore"
confidenceconfidencestring"high"