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

[Radar] Geofence Entered

Radar Event Field Amplitude 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"
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 "Bel Air"
geofence.tag Geofence Tag string "city"
geofence.externalId Geofence External ID string "bel-air"
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 "Target Bel Air"
place.facebookId Place Facebook ID string "141162456060553"
place.chain.slug Place Chain Slug string "target"
place.chain.name Place Chain Name string "Target"
place.categories Place Categories array[string] ["shopping-retail"]
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 "Target Bel Air"
place.facebookId Place Facebook ID string "141162456060553"
place.chain.slug Place Chain Slug string "target"
place.chain.name Place Chain Name string "Target"
place.categories Place Categories array[string] ["shopping-retail"]
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