Amplitude

The Amplitude integration is available on the Enterprise plan.

Radar can send events and user properties to Amplitude.

Use the Amplitude integration to enrich behavioral events with location context, measure the ROI of location-based features, and build location-based user segments.

Configuration

On the Amplitude Manage Project page, copy your API key.

Then, on the Radar Integrations page under Amplitude, set Enabled to Yes and paste your API key. Note that you can set separate API keys for the Test and Live environments.

Whenever events are generated, Radar will send events and user properties to Amplitude.

User mapping

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

Radar User Field	Amplitude User Property	Type	Example Value	Context Type
userId	userId	string	"1"
deviceId	deviceId	string	"10974a2ee035770b9"
location.coordinates[0]	location_lng	number	-76.350663
location.coordinates[1]	location_lat	number	39.525665
locationAuthorization	[Radar] Location Authorization	string	GRANTED_FOREGROUND
locationAccuracyAuthorization	[Radar] Location Accuracy Authorization	string	FULL
updatedAt	time	timestamp	"2018-06-22T15:23:39.000Z"
_id	[Radar] ID	string	"5b2c0906f5874b001aecfd8d"
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	Amplitude Event
user.entered_geofence	Geofences	[Radar] Geofence Entered
user.exited_geofence	Geofences	[Radar] Geofence Exited
user.dwelled_in_geofence	Geofences	[Radar] Dwelled in Geofence
user.entered_place	Places	[Radar] Place Entered
user.exited_place	Places	[Radar] Place Exited
user.entered_region_country	Regions	[Radar] Country Entered
user.exited_region_country	Regions	[Radar] Country Exited
user.entered_region_state	Regions	[Radar] State Entered
user.exited_region_state	Regions	[Radar] State Exited
user.entered_region_dma	Regions	[Radar] DMA Entered
user.exited_region_dma	Regions	[Radar] DMA Exited
user.started_trip	Trip Tracking	[Radar] Started Trip
user.updated_trip	Trip Tracking	[Radar] Updated Trip
user.approaching_trip_destination	Trip Tracking	[Radar] Approaching Trip Destination
user.arrived_at_trip_destination	Trip Tracking	[Radar] Arrived at Trip Destination
user.stopped_trip	Trip Tracking	[Radar] Stopped Trip
user.entered_beacon	Beacons	[Radar] Beacon Entered
user.exited_beacon	Beacons	[Radar] Beacon Exited

[Radar] Geofence Entered

Radar Event Field	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Geofence Exited

Radar Event Field	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true
duration	Duration	number (minutes)	42.1

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

Radar Event Field	Amplitude 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"

[Radar] Dwelled in Geofence

Radar Event Field	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true
duration	Duration	number (minutes)	5

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

Radar Event Field	Amplitude 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"

[Radar] Place Entered

Radar Event Field	Amplitude Event Property	Type	Example Value
place._id	Place ID	string	"59302bcf8f27e8a156bd4f91"
place.name	Place Name	string	"Starbucks"
place.chain.slug	Place Chain Slug	string	"starbucks"
place.chain.name	Place Chain Name	string	"Starbucks"
place.categories	Place Categories	array[string]	["food-beverage", "cafe", "coffee-shop"]
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Place Exited

Radar Event Field	Amplitude Event Property	Type	Example Value
place._id	Place ID	string	"59302bcf8f27e8a156bd4f91"
place.name	Place Name	string	"Starbucks"
place.chain.slug	Place Chain Slug	string	"starbucks"
place.chain.name	Place Chain Name	string	"Starbucks"
place.categories	Place Categories	array[string]	["food-beverage", "cafe", "coffee-shop"]
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true
duration	Duration	number (minutes)	42.1

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

Radar Event Field	Amplitude 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"

[Radar] Country Entered

Radar Event Field	Amplitude Event Property	Type	Example Value
region.code	Region Code	string	"US"
region.name	Region Name	string	"United States"
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Country Exited

Radar Event Field	Amplitude Event Property	Type	Example Value
region.code	Region Code	string	"US"
region.name	Region Name	string	"United States"
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] State Entered

Radar Event Field	Amplitude Event Property	Type	Example Value
region.code	Region Code	string	"MD"
region.name	Region Name	string	"Maryland"
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] State Exited

Radar Event Field	Amplitude Event Property	Type	Example Value
region.code	Region Code	string	"MD"
region.name	Region Name	string	"Maryland"
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] DMA Entered

Radar Event Field	Amplitude Event Property	Type	Example Value
region.code	Region Code	string	"26"
region.name	Region Name	string	"Baltimore"
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] DMA Exited

Radar Event Field	Amplitude Event Property	Type	Example Value
region.code	Region Code	string	"26"
region.name	Region Name	string	"Baltimore"
confidence	Confidence	string	"high"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Started Trip

Radar Event Attribute	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Updated Trip

Radar Event Attribute	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Approaching Trip Destination

Radar Event Attribute	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Arrived at Trip Destination

Radar Event Attribute	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Stopped Trip

Radar Event Attribute	Amplitude 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"
accuracy	Accuracy	number (meters)	5
foreground	Foreground	boolean	true

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

Radar Event Field	Amplitude 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"

[Radar] Beacon Entered

Radar Event Attribute	Amplitude 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"

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

Radar Event Field	Amplitude 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"

[Radar] Beacon Exited

Radar Event Attribute	Amplitude 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

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

Radar Event Field	Amplitude 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"