Skip to main content

Lytics

Radar can send events and user state to Lytics.

Use the Lytics integration to build location-based user segments.

The Lytics integration is available on the Enterprise plan.

Configuration#

Before enabling the integration, contact your Lytics account manager. After Lytics is configured, in Lytics, create an API token with no expiration and the Data Manager role.

Then, on the Radar Integrations page under Lytics, set Enabled to Yes, paste your API token. Note that you can set separate API tokens and stream names for the Test and Live environments.

Whenever events are generated, Radar will send events to the radar_events stream and user state to the radar_users stream.

User mapping#

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

Radar User FieldLytics User Data FieldTypeExample ValueContext Type
userIdradarUserIdstring"1"
deviceIdradarDeviceIdstring"10974a2ee035770b9"
location.coordinates[0]radarLocationLongitudenumber-76.350663
location.coordinates[1]radarLocationLatitudenumber39.525665
_idradarIdstring"5b2c0906f5874b001aecfd8d"
updatedAtradarUpdatedAttimestamp"2018-06-22T15:23:39.000Z"
segments[*].externalIdradarSegmentExternalIdsarray[string]["starbucks-visitors"]
topChains[*].slugradarTopChainSlugsarray[string]["starbucks", "walmart"]
topChains[*].externalIdradarTopChainExternalIdsarray[string]["123", "456"]
geofences[*]._idradarGeofenceIdsarray[string]["5b2c0906f5874b001aecfd8e"]Geofences
geofences[*].descriptionradarGeofenceDescriptionsarray[string]["Store #123"]Geofences
geofences[*].tagradarGeofenceTagsarray[string]["store"]Geofences
geofences[*].externalIdradarGeofenceExternalIdsarray[string]["123"]Geofences
place._idradarPlaceIdstring"59302bcf8f27e8a156bd4f91"Places
place.nameradarPlaceNamestring"Starbucks"Places
place.categoriesradarPlaceCategoriesarray[string]["food-beverage", "cafe", "coffee-shop"]Places
place.chain.slugradarPlaceChainSlugstring"starbucks"Places
place.chain.nameradarPlaceChainNamestring"Starbucks"Places
insights.state.homeradarInsightsStateHomebooleanfalseInsights
insights.state.officeradarInsightsStateOfficebooleanfalseInsights
insights.state.travelingradarInsightsStateTravelingbooleantrueInsights
country.coderadarRegionCountryCodestring"US"Regions
country.nameradarRegionCountryNamestring"United States"Regions
state.coderadarRegionStateCodestring"MD"Regions
state.nameradarRegionStateNamestring"Maryland"Regions
dma.coderadarRegionDMACodestring"26"Regions
dma.nameradarRegionDMANamestring"Baltimore"Regions
postalCode.coderadarRegionPostalCodestring"21014"Regions

Event mapping#

user.entered_geofence#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
geofence._idgeofenceIdstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofenceDescriptionstring"Store #123"
geofence.taggeofenceTagstring"store"
geofence.externalIdgeofenceExternalIdstring"123"
geofence.metadata[{key}]geofenceMetadata{key}{type}{value}
confidenceconfidencestring"high"

user.exited_geofence#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
geofence._idgeofenceIdstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofenceDescriptionstring"Store #123"
geofence.taggeofenceTagstring"store"
geofence.externalIdgeofenceExternalIdstring"123"
geofence.metadata[{key}]geofenceMetadata{key}{type}{value}
confidenceconfidencestring"high"
durationdurationnumber (minutes)42.1

user.entered_place#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
place._idplaceIdstring"59302bcf8f27e8a156bd4f91"
place.nameplaceNamestring"Starbucks"
place.chain.slugplaceChainSlugstring"starbucks"
place.chain.nameplaceChainNamestring"Starbucks"
place.categoriesplaceCategoriesarray[string]["food-beverage", "cafe", "coffee-shop"]
confidenceconfidencestring"high"

user.exited_place#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
place._idplaceIdstring"59302bcf8f27e8a156bd4f91"
place.nameplaceNamestring"Starbucks"
place.chain.slugplaceChainSlugstring"starbucks"
place.chain.nameplaceChainNamestring"Starbucks"
place.categoriesplaceCategoriesarray[string]["food-beverage", "cafe", "coffee-shop"]
confidenceconfidencestring"high"
durationdurationnumber (minutes)42.1

user.entered_home#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
confidenceconfidencestring"high"

user.exited_home#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
confidenceconfidencestring"high"

user.entered_office#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
confidenceconfidencestring"high"

user.exited_office#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
confidenceconfidencestring"high"

user.started_traveling#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
confidenceconfidencestring"high"

user.stopped_traveling#

Radar Event FieldLytics Event Data FieldTypeExample
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
confidenceconfidencestring"high"

user.entered_region_country#

Radar Event FieldLytics Event Data FieldTypeExample Value
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
region.coderegionCodestring"US"
region.nameregionNamestring"United States"
confidenceconfidencestring"high"

user.exited_region_country#

Radar Event FieldLytics Event Data FieldTypeExample Value
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
region.coderegionCodestring"US"
region.nameregionNamestring"United States"
confidenceconfidencestring"high"

user.entered_region_state#

Radar Event FieldLytics Event Data FieldTypeExample Value
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
region.coderegionCodestring"MD"
region.nameregionNamestring"Maryland"
confidenceconfidencestring"high"

user.exited_region_state#

Radar Event FieldLytics Event Data FieldTypeExample Value
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
region.coderegionCodestring"MD"
region.nameregionNamestring"Maryland"
confidenceconfidencestring"high"

user.entered_region_dma#

Radar Event FieldLytics Event Data FieldTypeExample Value
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
region.coderegionCodestring"26"
region.nameregionNamestring"Baltimore"
confidenceconfidencestring"high"

user.exited_region_dma#

Radar Event FieldLytics Event Data FieldTypeExample Value
user.userIduserUserIdstring"1"
user.deviceIduserDeviceIdstring"10974a2ee035770b9"
region.coderegionCodestring"26"
region.nameregionNamestring"Baltimore"
confidenceconfidencestring"high"

user.started_trip#

Radar Event AttributeLytics Event Data FieldTypeExample Value
trip.externalIdtripExternalIdstring"299"
trip.metadata[{key}]tripMetadata{key}{type}{value}
trip.destinationGeofenceTagtripDestinationGeofenceTagstring"store"
trip.destinationGeofenceExternalIdtripDestinationGeofenceExternalIdstring"123"

user.updated_trip#

Radar Event AttributeLytics Event Data FieldTypeExample Value
trip.externalIdtripExternalIdstring"299"
trip.metadata[{key}]tripMetadata{key}{type}{value}
trip.destinationGeofenceTagtripDestinationGeofenceTagstring"store"
trip.destinationGeofenceExternalIdtripDestinationGeofenceExternalIdstring"123"

user.approaching_trip_destination#

Radar Event AttributeLytics Event Data FieldTypeExample Value
trip.externalIdtripExternalIdstring"299"
trip.metadata[{key}]tripMetadata{key}{type}{value}
trip.destinationGeofenceTagtripDestinationGeofenceTagstring"store"
trip.destinationGeofenceExternalIdtripDestinationGeofenceExternalIdstring"123"

user.arrived_at_trip_destination#

Radar Event AttributeLytics Event Data FieldTypeExample Value
trip.externalIdtripExternalIdstring"299"
trip.metadata[{key}]tripMetadata{key}{type}{value}
trip.destinationGeofenceTagtripDestinationGeofenceTagstring"store"
trip.destinationGeofenceExternalIdtripDestinationGeofenceExternalIdstring"123"

user.stopped_trip#

Radar Event AttributeLytics Event Data FieldTypeExample Value
trip.externalIdtripExternalIdstring"299"
trip.metadata[{key}]tripMetadata{key}{type}{value}
trip.destinationGeofenceTagtripDestinationGeofenceTagstring"store"
trip.destinationGeofenceExternalIdtripDestinationGeofenceExternalIdstring"123"