Airship Integration Reference

Contents

Introduction

Whenever events are generated, Radar will send custom events and tags to Airship. The full list of supported tags and events is below.

User mapping

Note that for tags to populate, you must manually create tag groups in Airship first using the tag group names below.

Radar User Field Airship Tag Group Name Type Example Tag Context Type
location.coordinates[0] radar_location_longitude number -76.350663
location.coordinates[1] radar_location_latitude number 39.525665
updatedAt radar_updated_at timestamp "2018-06-22T15:23:39.000Z"
segments[*].externalId radar_segment_external_ids string "starbucks-visitors"
topChains[*].slug radar_top_chain_slugs string "starbucks"
topChains[*].externalId radar_top_chain_external_ids string "123"
geofences[*]._id radar_geofence_ids string "5b2c0906f5874b001aecfd8e" Geofences
geofences[*].description radar_geofence_descriptions array[string] ["Store #123"] Geofences
geofences[*].tag radar_geofence_tags string "store" Geofences
geofences[*].externalId radar_geofence_external_ids string "123" Geofences
place._id radar_place_id string "59302bcf8f27e8a156bd4f91" Places
place.name radar_place_name string "Starbucks" Places
place.categories radar_place_categories string "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 Airship 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_stopped
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 Airship Event Property Type Example Value
geofence._id radar_geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description radar_geofence_description string "Store #123"
geofence.tag radar_geofence_tag string "store"
geofence.externalId radar_geofence_external_id string "123"
geofence.metadata[{key}] radar_geofence_metadata_{key} {type} {value}
confidence radar_confidence string "high"

radar_geofence_exited

Radar Event Field Airship Event Property Type Example Value
geofence._id radar_geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description radar_geofence_description string "Store #123"
geofence.tag radar_geofence_tag string "store"
geofence.externalId radar_geofence_external_id string "123"
geofence.metadata[{key}] radar_geofence_metadata_{key} {type} {value}
confidence radar_confidence string "high"
duration radar_duration number (minutes) 42.1

radar_place_entered

Radar Event Field Airship Event Property Type Example Value
place._id radar_place_id string "59302bcf8f27e8a156bd4f91"
place.name radar_place_name string "Starbucks"
place.chain.slug radar_place_chain_id string "starbucks"
place.chain.name radar_place_chain_name string "Starbucks"
place.categories radar_place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence radar_confidence string "high"

radar_place_exited

Radar Event Field Airship Event Property Type Example Value
place._id radar_place_id string "59302bcf8f27e8a156bd4f91"
place.name radar_place_name string "Starbucks"
place.chain.slug radar_place_chain_id string "starbucks"
place.chain.name radar_place_chain_name string "Starbucks"
place.categories radar_place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence radar_confidence string "high"
duration radar_duration number (minutes) 42.1

radar_home_entered

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_home_exited

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_office_entered

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_office_exited

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_traveling_started

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_traveling_stopped

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_country_entered

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "US"
region.name radar_region_name string "United States"
confidence radar_confidence string "high"

radar_country_exited

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "US"
region.name radar_region_name string "United States"
confidence radar_confidence string "high"

radar_state_entered

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "MD"
region.name radar_region_name string "Maryland"
confidence radar_confidence string "high"

radar_state_exited

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "MD"
region.name radar_region_name string "Maryland"
confidence radar_confidence string "high"

radar_dma_entered

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "26"
region.name radar_region_name string "Baltimore"
confidence radar_confidence string "high"

radar_dma_exited

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "26"
region.name radar_region_name string "Baltimore"
confidence radar_confidence string "high"