Amplitude Integration Reference

Contents

Introduction

Whenever events are generated, Radar will send events and user properties to Amplitude. The full list of supported events and user properties and events is below.

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
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
insights.state.home [Radar] Insights State Home boolean false Insights
insights.state.office [Radar] Insights State Office boolean false Insights
insights.state.traveling [Radar] Insights State Traveling boolean true Insights
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

Event mapping

Radar Event Context Type Amplitude Event
user.entered_geofence Geofences [Radar] Geofence Entered
user.exited_geofence Geofences [Radar] Geofence Exited
user.entered_place Places [Radar] Place Entered
user.exited_place Places [Radar] Place Exited
user.entered_home Insights [Radar] Home Entered
user.exited_home Insights [Radar] Home Exited
user.entered_office Insights [Radar] Office Entered
user.exited_office Insights [Radar] Office Exited
user.started_traveling Insights [Radar] Traveling Started
user.stopped_traveling Insights [Radar] Traveling Stoppped
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

[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

[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
duration Duration number (minutes) 42.1

[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

[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
duration Duration number (minutes) 42.1

[Radar] Home Entered

Radar Event Field Amplitude Event Property Type Example Value
confidence Confidence string "high"
accuracy Accuracy number (meters) 5

[Radar] Home Exited

Radar Event Field Amplitude Event Property Type Example Value
confidence Confidence string "high"
accuracy Accuracy number (meters) 5

[Radar] Office Entered

Radar Event Field Amplitude Event Property Type Example Value
confidence Confidence string "high"
accuracy Accuracy number (meters) 5

[Radar] Office Exited

Radar Event Field Amplitude Event Property Type Example Value
confidence Confidence string "high"
accuracy Accuracy number (meters) 5

[Radar] Traveling Started

Radar Event Field Amplitude Event Property Type Example Value
confidence Confidence string "high"
accuracy Accuracy number (meters) 5

[Radar] Traveling Stopped

Radar Event Field Amplitude Event Property Type Example Value
confidence Confidence string "high"
accuracy Accuracy number (meters) 5

[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"

[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"

[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"

[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"

[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"

[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"