Skip to main content

Amplitude

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.

The Amplitude integration is available on the Team plan or higher.

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 FieldAmplitude User PropertyTypeExample ValueContext Type
userIduserIdstring"1"
deviceIddeviceIdstring"10974a2ee035770b9"
location.coordinates[0]location_lngnumber-76.350663
location.coordinates[1]location_latnumber39.525665
updatedAttimetimestamp"2018-06-22T15:23:39.000Z"
_id[Radar] IDstring"5b2c0906f5874b001aecfd8d"
segments[*].externalId[Radar] Segment External IDsarray[string]["starbucks-visitors"]
topChains[*].slug[Radar] Top Chain Slugsarray[string]["starbucks", "walmart"]
topChains[*].externalId[Radar] Top Chain External IDsarray[string]["123", "456"]
geofences[*]._id[Radar] Geofence IDsarray[string]["5b2c0906f5874b001aecfd8e"]Geofences
geofences[*].description[Radar] Geofence Descriptionsarray[string]["Store #123"]Geofences
geofences[*].tag[Radar] Geofence Tagsarray[string]["store"]Geofences
geofences[*].externalId[Radar] Geofence External IDsarray[string]["123"]Geofences
place._id[Radar] Place IDstring"59302bcf8f27e8a156bd4f91"Places
place.name[Radar] Place Namestring"Starbucks"Places
place.categories[Radar] Place Categoriesarray[string]["food-beverage", "cafe", "coffee-shop"]Places
place.chain.slug[Radar] Place Chain Slugstring"starbucks"Places
place.chain.name[Radar] Place Chain Namestring"Starbucks"Places
insights.state.home[Radar] Insights State HomebooleanfalseInsights
insights.state.office[Radar] Insights State OfficebooleanfalseInsights
insights.state.traveling[Radar] Insights State TravelingbooleantrueInsights
country.code[Radar] Region Country Codestring"US"Regions
country.name[Radar] Region Country Namestring"United States"Regions
state.code[Radar] Region State Codestring"MD"Regions
state.name[Radar] Region State Namestring"Maryland"Regions
dma.code[Radar] Region DMA Codestring"26"Regions
dma.name[Radar] Region DMA Namestring"Baltimore"Regions
postalCode.code[Radar] Region Postal Codestring"21014"Regions

Event mapping#

Radar EventContext TypeAmplitude Event
user.entered_geofenceGeofences[Radar] Geofence Entered
user.exited_geofenceGeofences[Radar] Geofence Exited
user.entered_placePlaces[Radar] Place Entered
user.exited_placePlaces[Radar] Place Exited
user.entered_homeInsights[Radar] Home Entered
user.exited_homeInsights[Radar] Home Exited
user.entered_officeInsights[Radar] Office Entered
user.exited_officeInsights[Radar] Office Exited
user.started_travelingInsights[Radar] Traveling Started
user.stopped_travelingInsights[Radar] Traveling Stoppped
user.entered_region_countryRegions[Radar] Country Entered
user.exited_region_countryRegions[Radar] Country Exited
user.entered_region_stateRegions[Radar] State Entered
user.exited_region_stateRegions[Radar] State Exited
user.entered_region_dmaRegions[Radar] DMA Entered
user.exited_region_dmaRegions[Radar] DMA Exited

[Radar] Geofence Entered#

Radar Event FieldAmplitude 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"
accuracyAccuracynumber (meters)5

[Radar] Geofence Exited#

Radar Event FieldAmplitude 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"
accuracyAccuracynumber (meters)5
durationDurationnumber (minutes)42.1

[Radar] Place Entered#

Radar Event FieldAmplitude Event PropertyTypeExample Value
place._idPlace IDstring"59302bcf8f27e8a156bd4f91"
place.namePlace Namestring"Starbucks"
place.chain.slugPlace Chain Slugstring"starbucks"
place.chain.namePlace Chain Namestring"Starbucks"
place.categoriesPlace Categoriesarray[string]["food-beverage", "cafe", "coffee-shop"]
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Place Exited#

Radar Event FieldAmplitude Event PropertyTypeExample Value
place._idPlace IDstring"59302bcf8f27e8a156bd4f91"
place.namePlace Namestring"Starbucks"
place.chain.slugPlace Chain Slugstring"starbucks"
place.chain.namePlace Chain Namestring"Starbucks"
place.categoriesPlace Categoriesarray[string]["food-beverage", "cafe", "coffee-shop"]
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5
durationDurationnumber (minutes)42.1

[Radar] Home Entered#

Radar Event FieldAmplitude Event PropertyTypeExample Value
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Home Exited#

Radar Event FieldAmplitude Event PropertyTypeExample Value
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Office Entered#

Radar Event FieldAmplitude Event PropertyTypeExample Value
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Office Exited#

Radar Event FieldAmplitude Event PropertyTypeExample Value
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Traveling Started#

Radar Event FieldAmplitude Event PropertyTypeExample Value
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Traveling Stopped#

Radar Event FieldAmplitude Event PropertyTypeExample Value
confidenceConfidencestring"high"
accuracyAccuracynumber (meters)5

[Radar] Country Entered#

Radar Event FieldAmplitude Event PropertyTypeExample Value
region.codeRegion Codestring"US"
region.nameRegion Namestring"United States"
confidenceConfidencestring"high"

[Radar] Country Exited#

Radar Event FieldAmplitude Event PropertyTypeExample Value
region.codeRegion Codestring"US"
region.nameRegion Namestring"United States"
confidenceConfidencestring"high"

[Radar] State Entered#

Radar Event FieldAmplitude Event PropertyTypeExample Value
region.codeRegion Codestring"MD"
region.nameRegion Namestring"Maryland"
confidenceConfidencestring"high"

[Radar] State Exited#

Radar Event FieldAmplitude Event PropertyTypeExample Value
region.codeRegion Codestring"MD"
region.nameRegion Namestring"Maryland"
confidenceConfidencestring"high"

[Radar] DMA Entered#

Radar Event FieldAmplitude Event PropertyTypeExample Value
region.codeRegion Codestring"26"
region.nameRegion Namestring"Baltimore"
confidenceConfidencestring"high"

[Radar] DMA Exited#

Radar Event FieldAmplitude Event PropertyTypeExample Value
region.codeRegion Codestring"26"
region.nameRegion Namestring"Baltimore"
confidenceConfidencestring"high"