Segment

The Segment integration is available on the Enterprise plan.

Radar can send events and user traits to Segment as a source. Segment can send those events and user traits to your warehouse and to hundreds of destinations. Use the Segment integration to forward location events and user context to any destinations or to build location-based user segments with Personas.

Configuration

In Segment, add Radar as a source and copy your write key. Then, on the Radar Integrations page under Segment Source, set Enabled to Yes and paste your write key. Note that you can set separate write keys for the Test and Live environments. Whenever events are generated, Radar will call track and identify to send events and user traits to Segment. By default, Radar userId maps to Segment userId for logged in users, and Radar deviceId maps to Segment anonymousId for logged out users. However, you can specify custom mappings by setting Radar metadata.segmentUserId or metadata.segmentAnonymousId. For example, on iOS:

// track logged out users with custom anonymousId mapping (not required if using default mapping)
Radar.setMetadata(["segmentAnonymousId": anonymousId])

// track logged in users with custom userId mapping (not required if using default mapping)
Radar.setMetadata(["segmentUserId": userId])

User mapping

Note that Radar uses the special string "(null)" to represent null user trait values.

Radar User Field	Segment User Trait	Type	Example Value	Context Type
`metadata.segmentUserId` or `userId`	`userId`	string	`"1"`
`metadata.segmentAnonymousId` or `deviceId`	`anonymousId`	string	`"10974a2ee035770b9"`
`_id`	`radar_id`	string	`"5b2c0906f5874b001aecfd8d"`
`location.coordinates[1]`	`radar_location_latitude`	number	`39.525665`
`location.coordinates[0]`	`radar_location_longitude`	number	`-76.350663`
`locationAuthorization`	`radar_location_authorization`	string	`"GRANTED_FOREGROUND"`
`locationAccuracyAuthorization`	`radar_location_accuracy_authorization`	string	`"FULL"`
`updatedAt`	`radar_updated_at`	timestamp	`"2018-06-22T15:23:39.000Z"`
`segments[*].externalId`	`radar_segment_external_ids`	array[string]	`["starbucks-visitors"]`
`topChains[*].slug`	`radar_top_chain_slugs`	array[string]	`["starbucks", "walmart"]`
`topChains[*].externalId`	`radar_top_chain_external_ids`	array[string]	`["123", "456"]`
`geofences[*]._id`	`radar_geofence_ids`	array[string]	`["5b2c0906f5874b001aecfd8e"]`	Geofences
`geofences[*].description`	`radar_geofence_descriptions`	array[string]	`["Store #123"]`	Geofences
`geofences[*].tag`	`radar_geofence_tags`	array[string]	`["store"]`	Geofences
`geofences[*].externalId`	`radar_geofence_external_ids`	array[string]	`["123"]`	Geofences
`place._id`	`radar_place_id`	string	`"59302bcf8f27e8a156bd4f91"`	Places
`place.name`	`radar_place_name`	string	`"Starbucks"`	Places
`place.categories`	`radar_place_categories`	array[string]	`["food-beverage", "cafe", "coffee-shop"]`	Places
`place.chain.slug`	`radar_place_chain_slug`	string	`"starbucks"`	Places
`place.chain.name`	`radar_place_chain_name`	string	`"Starbucks"`	Places
`country.code`	`radar_region_country_code`	string	`"US"`	Regions
`country.name`	`radar_region_country_name`	string	`"United States"`	Regions
`state.code`	`radar_region_state_code`	string	`"MD"`	Regions
`state.name`	`radar_region_state_name`	string	`"Maryland"`	Regions
`dma.code`	`radar_region_dma_code`	string	`"26"`	Regions
`dma.name`	`radar_region_dma_name`	string	`"Baltimore"`	Regions
`postalCode.code`	`radar_region_postal_code`	string	`"21014"`	Regions
`trip.externalId`	`radar_trip_external_id`	string	`"299"`	Trip Tracking
`trip.destinationGeofenceTag`	`radar_trip_destination_geofence_tag`	string	`"store"`	Trip Tracking
`trip.destinationGeofenceExternalId`	`radar_trip_destination_geofence_external_id`	string	`"123"`	Trip Tracking
`beacons[*]._id`	`radar_beacon_ids`	array[string]	`["5b2c0906f5874b001aecfd8f]"`	Beacons
`beacons[*].description`	`radar_beacon_descriptions`	array[string]	`["Store #123 - Drive-Thru"]`	Beacons
`beacons[*].tag`	`radar_beacon_tags`	array[string]	`["drive-thru"]`	Beacons
`beacons[*].externalId`	`radar_beacon_external_ids`	array[string]	`["123"]`	Beacons

Event mapping

Radar Event	Context Type	Segment Event
`user.entered_geofence`	Geofences	`Geofence Entered`
`user.exited_geofence`	Geofences	`Geofence Exited`
`user.dwelled_in_geofence`	Geofences	`Dwelled in Geofence`
`user.entered_place`	Places	`Place Entered`
`user.exited_place`	Places	`Place Exited`
`user.entered_region_country`	Regions	`Country Entered`
`user.exited_region_country`	Regions	`Country Exited`
`user.entered_region_state`	Regions	`State Entered`
`user.exited_region_state`	Regions	`State Exited`
`user.entered_region_dma`	Regions	`DMA Entered`
`user.exited_region_dma`	Regions	`DMA Exited`
`user.started_trip`	Trip Tracking	`Trip Started`
`user.updated_trip`	Trip Tracking	`Trip Updated`
`user.approaching_trip_destination`	Trip Tracking	`Trip Approaching Destination`
`user.arrived_at_trip_destination`	Trip Tracking	`Trip Arrived Destination`
`user.stopped_trip`	Trip Tracking	`Trip Stopped`
`user.entered_beacon`	Beacons	`Beacon Entered`
`user.exited_beacon`	Beacons	`Beacon Exited`

Geofence Entered

Radar Event Field	Segment 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`

Geofence Exited

Radar Event Field	Segment 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`

Dwelled in Geofence

Radar Event Field	Segment 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`

Place Entered

Radar Event Field	Segment 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.metadata[{key}]`	`place_chain_metadata_{key}`	type	`{value}`
`place.categories`	`place_categories`	array[string]	`["food-beverage", "cafe", "coffee-shop"]`
`confidence`	`confidence`	string	`"high"`
`foreground`	`foreground`	boolean	`true`

Place Exited

Radar Event Field	Segment 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.metadata[{key}]`	`place_chain_metadata_{key}`	type	`{value}`
`place.categories`	`place_categories`	array[string]	`["food-beverage", "cafe", "coffee-shop"]`
`confidence`	`confidence`	string	`"high"`
`duration`	`duration`	number (minutes)	`42.1`
`foreground`	`foreground`	boolean	`true`

Country Entered

Radar Event Field	Segment 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`

Country Exited

Radar Event Field	Segment 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`

State Entered

Radar Event Field	Segment 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`

State Exited

Radar Event Field	Segment 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`

DMA Entered

Radar Event Field	Segment 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`

DMA Exited

Radar Event Field	Segment 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`

Trip Started

Radar Event Attribute	Segment 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`

Trip Updated

Radar Event Attribute	Segment 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`

Trip Approaching Destination

Radar Event Attribute	Segment 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`

Trip Arrived Destination

Radar Event Attribute	Segment 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`

Trip Stopped

Radar Event Attribute	Segment 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`

Beacon Entered

Radar Event Attribute	Segment 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`

Beacon Exited

Radar Event Attribute	Segment 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`

Home

Geofencing Platform

Maps Platform

SDK Reference

API

Tutorials

Waypoint

FAQs

Configuration

User mapping

Event mapping

Geofence Entered

Geofence Exited

Dwelled in Geofence

Place Entered

Place Exited

Country Entered

Country Exited

State Entered

State Exited

DMA Entered

DMA Exited

Trip Started

Trip Updated

Trip Approaching Destination

Trip Arrived Destination

Trip Stopped

Beacon Entered

Beacon Exited

​Configuration

​User mapping

​Event mapping

​Geofence Entered

​Geofence Exited

​Dwelled in Geofence

​Place Entered

​Place Exited

​Country Entered

​Country Exited

​State Entered

​State Exited

​DMA Entered

​DMA Exited

​Trip Started

​Trip Updated

​Trip Approaching Destination

​Trip Arrived Destination

​Trip Stopped

​Beacon Entered

​Beacon Exited

Configuration

User mapping

Event mapping

Geofence Entered

Geofence Exited

Dwelled in Geofence

Place Entered

Place Exited

Country Entered

Country Exited

State Entered

State Exited

DMA Entered

DMA Exited

Trip Started

Trip Updated

Trip Approaching Destination

Trip Arrived Destination

Trip Stopped

Beacon Entered

Beacon Exited