Segment Integration Reference

Contents

Introduction

Whenever events are generated, Radar will send custom events and user traits to Segment. The full list of supported user traits and events is below.

User mapping

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])

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

Radar User Field Segment User Trait Type Example Value
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
updatedAt radar_updated_at timestamp "2018-06-22T15:23:39.000Z"
geofences[]._id radar_geofence_ids array[string] ["5b2c0906f5874b001aecfd8e"]
geofences[].description radar_geofence_descriptions array[string] ["Bel Air"]
geofences[].tag radar_geofence_tags array[string] ["city"]
geofences[].externalId radar_geofence_external_ids array[string] ["bel-air"]
place._id radar_place_id string "59302bcf8f27e8a156bd4f91"
place.name radar_place_name string "Target Bel Air"
place.facebookId radar_place_facebook_id string "141162456060553"
place.categories radar_place_categories array[string] ["shopping-retail"]
place.chain.slug radar_place_chain_slug string "target"
place.chain.name radar_place_chain_name string "Target"
insights.state.home radar_insights_state_home boolean false
insights.state.office radar_insights_state_office boolean false
insights.state.traveling radar_insights_state_traveling boolean true

Event mapping

Radar Event Segment Event
user.entered_geofence Geofence Entered
user.exited_geofence Geofence Exited
user.entered_place Place Entered
user.exited_place Place Exited
user.entered_home Home Entered
user.exited_home Home Exited
user.entered_office Office Entered
user.exited_office Office Exited
user.started_traveling Traveling Started
user.stopped_traveling Traveling Stopped

Geofence Entered

Radar Event Attribute Segment Event Property Type Example Value
geofence._id geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description geofence_description string "Bel Air"
geofence.tag geofence_tag string "city"
geofence.externalId geofence_external_id string "bel-air"
confidence confidence string "high"

Geofence Exited

Radar Event Attribute Segment Event Property Type Example Value
geofence._id geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description geofence_description string "Bel Air"
geofence.tag geofence_tag string "city"
geofence.externalId geofence_external_id string "bel-air"
confidence confidence string "high"
duration duration number (minutes) 42.1

Place Entered

Radar Event Attribute Segment Event Property Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Target Bel Air"
place.facebookId place_facebook_id string "141162456060553"
place.chain.slug place_chain_id string "target"
place.chain.name place_chain_name string "Target"
place.categories place_categories array[string] ["shopping-retail"]
confidence confidence string "high"

Place Exited

Radar Event Attribute Segment Event Property Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Target Bel Air"
place.facebookId place_facebook_id string "141162456060553"
place.chain.slug place_chain_id string "target"
place.chain.name place_chain_name string "Target"
place.categories place_categories array[string] ["shopping-retail"]
confidence confidence string "high"
duration duration number (minutes) 42.1

Home Entered

Radar Event Attribute Segment Event Property Type Example Value
confidence confidence string "high"

Home Exited

Radar Event Attribute Segment Event Property Type Example Value
confidence confidence string "high"

Office Entered

Radar Event Attribute Segment Event Property Type Example Value
confidence confidence string "high"

Office Exited

Radar Event Attribute Segment Event Property Type Example Value
confidence confidence string "high"

Traveling Started

Radar Event Attribute Segment Event Property Type Example Value
confidence confidence string "high"

Traveling Stopped

Radar Event Attribute Segment Event Property Type Example Value
confidence confidence string "high"