Iterable Integration Reference

Contents

• Introduction
• User mapping
• Event mapping
  • radarGeofenceEntered
  • radarGeofenceExited
  • radarPlaceEntered
  • radarPlaceExited
  • radarHomeEntered
  • radarHomeExited
  • radarOfficeEntered
  • radarOfficeExited
  • radarTravelingStarted
  • radarTravelingStopped
  • radarCountryEntered
  • radarCountryExited
  • radarStateEntered
  • radarStateExited
  • radarDMAEntered
  • radarDMAExited

Introduction

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

User mapping

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

Radar User Field	Iterable User Data Field	Type	Example Value	Context Type
userId	userId	string	"1"
location.coordinates[0]	radarLocationLongitude	number	-76.350663
location.coordinates[1]	radarLocationLatitude	number	39.525665
_id	radarId	string	"5b2c0906f5874b001aecfd8d"
updatedAt	radarUpdatedAt	timestamp	"2018-06-22T15:23:39.000Z"
segments[*].externalId	radarSegmentExternalIds	array[string]	["starbucks-visitors"]
topChains[*].slug	radarTopChainSlugs	array[string]	["starbucks", "walmart"]
topChains[*].externalId	radarTopChainExternalIds	array[string]	["123", "456"]
geofences[*]._id	radarGeofenceIds	array[string]	["5b2c0906f5874b001aecfd8e"]	Geofences
geofences[*].description	radarGeofenceDescriptions	array[string]	["Store #123"]	Geofences
geofences[*].tag	radarGeofenceTags	array[string]	["store"]	Geofences
geofences[*].externalId	radarGeofenceExternalIds	array[string]	["123"]	Geofences
place._id	radarPlaceId	string	"59302bcf8f27e8a156bd4f91"	Places
place.name	radarPlaceName	string	"Starbucks"	Places
place.categories	radarPlaceCategories	array[string]	["food-beverage", "cafe", "coffee-shop"]	Places
place.chain.slug	radarPlaceChainSlug	string	"starbucks"	Places
place.chain.name	radarPlaceChainName	string	"Starbucks"	Places
insights.state.home	radarInsightsStateHome	boolean	false	Insights
insights.state.office	radarInsightsStateOffice	boolean	false	Insights
insights.state.traveling	radarInsightsStateTraveling	boolean	true	Insights
country.code	radarRegionCountryCode	string	"US"	Regions
country.name	radarRegionCountryName	string	"United States"	Regions
state.code	radarRegionStateCode	string	"MD"	Regions
state.name	radarRegionStateName	string	"Maryland"	Regions
dma.code	radarRegionDMACode	string	"26"	Regions
dma.name	radarRegionDMAName	string	"Baltimore"	Regions
postalCode.code	radarRegionPostalCode	string	"21014"	Regions

Event mapping

Radar Event	Context Type	Iterable Event
user.entered_geofence	Geofences	radarGeofenceEntered
user.exited_geofence	Geofences	radarGeofenceExited
user.entered_place	Places	radarPlaceEntered
user.exited_place	Places	radarPlaceExited
user.entered_home	Insights	radarHomeEntered
user.exited_home	Insights	radarHomeExited
user.entered_office	Insights	radarOfficeEntered
user.exited_office	Insights	radarOfficeExited
user.started_traveling	Insights	radarTravelingStarted
user.stopped_traveling	Insights	radarTravelingStopped
user.entered_region_country	Regions	radarCountryEntered
user.exited_region_country	Regions	radarCountryExited
user.entered_region_state	Regions	radarStateEntered
user.exited_region_state	Regions	radarStateExited
user.entered_region_dma	Regions	radarDMAEntered
user.exited_region_dma	Regions	radarDMAExited

radarGeofenceEntered

Radar Event Field	Iterable Event Data Field	Type	Example
geofence._id	geofenceId	string	"5b2c0906f5874b001aecfd8e"
geofence.description	geofenceDescription	string	"Store #123"
geofence.tag	geofenceTag	string	"store"
geofence.externalId	geofenceExternalId	string	"123"
geofence.metadata[{key}]	geofenceMetadata{key}	{type}	{value}
confidence	confidence	string	"high"

radarGeofenceExited

Radar Event Field	Iterable Event Data Field	Type	Example
geofence._id	geofenceId	string	"5b2c0906f5874b001aecfd8e"
geofence.description	geofenceDescription	string	"Store #123"
geofence.tag	geofenceTag	string	"store"
geofence.externalId	geofenceExternalId	string	"123"
geofence.metadata[{key}]	geofenceMetadata{key}	{type}	{value}
confidence	confidence	string	"high"
duration	duration	number (minutes)	42.1

radarPlaceEntered

Radar Event Field	Iterable Event Data Field	Type	Example
place._id	placeId	string	"59302bcf8f27e8a156bd4f91"
place.name	placeName	string	"Starbucks"
place.chain.slug	placeChainSlug	string	"starbucks"
place.chain.name	placeChainName	string	"Starbucks"
place.categories	placeCategories	array[string]	["food-beverage", "cafe", "coffee-shop"]
confidence	confidence	string	"high"

radarPlaceExited

Radar Event Field	Iterable Event Data Field	Type	Example
place._id	placeId	string	"59302bcf8f27e8a156bd4f91"
place.name	placeName	string	"Starbucks"
place.chain.slug	placeChainSlug	string	"starbucks"
place.chain.name	placeChainName	string	"Starbucks"
place.categories	placeCategories	array[string]	["food-beverage", "cafe", "coffee-shop"]
confidence	confidence	string	"high"
duration	duration	number (minutes)	42.1

radarHomeEntered

Radar Event Field	Iterable Event Data Field	Type	Example
confidence	confidence	string	"high"

radarHomeExited

Radar Event Field	Iterable Event Data Field	Type	Example
confidence	confidence	string	"high"

radarOfficeEntered

Radar Event Field	Iterable Event Data Field	Type	Example
confidence	confidence	string	"high"

radarOfficeExited

Radar Event Field	Iterable Event Data Field	Type	Example
confidence	confidence	string	"high"

radarTravelingStarted

Radar Event Field	Iterable Event Data Field	Type	Example
confidence	confidence	string	"high"

radarTravelingStopped

Radar Event Field	Iterable Event Data Field	Type	Example
confidence	confidence	string	"high"

radarCountryEntered

Radar Event Field	Iterable Event Data Field	Type	Example Value
region.code	regionCode	string	"US"
region.name	regionName	string	"United States"
confidence	confidence	string	"high"

radarCountryExited

Radar Event Field	Iterable Event Data Field	Type	Example Value
region.code	regionCode	string	"US"
region.name	regionName	string	"United States"
confidence	confidence	string	"high"

radarStateEntered

Radar Event Field	Iterable Event Data Field	Type	Example Value
region.code	regionCode	string	"MD"
region.name	regionName	string	"Maryland"
confidence	confidence	string	"high"

radarStateExited

Radar Event Field	Iterable Event Data Field	Type	Example Value
region.code	regionCode	string	"MD"
region.name	regionName	string	"Maryland"
confidence	confidence	string	"high"

radarDMAEntered

Radar Event Field	Iterable Event Data Field	Type	Example Value
region.code	regionCode	string	"26"
region.name	regionName	string	"Baltimore"
confidence	confidence	string	"high"

radarDMAExited

Radar Event Field	Iterable Event Data Field	Type	Example Value
region.code	regionCode	string	"26"
region.name	regionName	string	"Baltimore"
confidence	confidence	string	"high"