mParticle Integration Reference

Contents

Introduction

Whenever events are generated, Radar will send custom events and user attributes to mParticle. The full list of supported user attributes and events is below.

User mapping

By default, Radar userId maps to mParticle customerid for logged in users. However, you can specify a custom mapping by setting Radar metadata.mParticleCustomerId. For example, on iOS:

// track logged in users with custom userId mapping (not required if using default mapping)
Radar.setMetadata(["mParticleCustomerId": customerid])

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

Radar User Field mParticle User Attribute Type Example Value Context Type
metadata.mParticleCustomerId or userId customerid string "1"
deviceId ios_idfv or android_uuid string "10974a2ee035770b9"
location current_location location (39.525665, -76.350663)
_id radar_id string "5b2c0906f5874b001aecfd8d"
updatedAt radar_updated_at timestamp "2018-06-22T15:23:39.000Z"
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

user.entered_geofence

Radar Event Field mParticle Event Attribute 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"

user.exited_geofence

Radar Event Field mParticle Event Attribute 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"
duration duration number (minutes) 42.1

user.entered_place

Radar Event Field mParticle Event Attribute 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 string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence confidence string "high"

user.exited_place

Radar Event Field mParticle Event Attribute Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Target"
place.chain.slug place_chain_slug string "target"
place.chain.name place_chain_name string "Target"
place.categories place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence confidence string "high"
duration duration number (minutes) 42.1

user.entered_home

Radar Event Field mParticle Event Attribute Type Example Value
confidence confidence string "high"

user.exited_home

Radar Event Field mParticle Event Attribute Type Example Value
confidence confidence string "high"

user.entered_office

Radar Event Field mParticle Event Attribute Type Example Value
confidence confidence string "high"

user.exited_office

Radar Event Field mParticle Event Attribute Type Example Value
confidence confidence string "high"

user.started_traveling

Radar Event Field mParticle Event Attribute Type Example Value
confidence confidence string "high"

user.stopped_traveling

Radar Event Field mParticle Event Attribute Type Example Value
confidence confidence string "high"

user.entered_region_country

Radar Event Attribute mParticle Event Attribute Type Example Value
region.code region_code string "US"
region.name region_name string "United States"
confidence confidence string "high"

user.exited_region_country

Radar Event Attribute mParticle Event Attribute Type Example Value
region.code region_code string "US"
region.name region_name string "United States"
confidence confidence string "high"

user.entered_region_state

Radar Event Attribute mParticle Event Attribute Type Example Value
region.code region_code string "MD"
region.name region_name string "Maryland"
confidence confidence string "high"

user.exited_region_state

Radar Event Attribute mParticle Event Attribute Type Example Value
region.code region_code string "MD"
region.name region_name string "Maryland"
confidence confidence string "high"

user.entered_region_dma

Radar Event Attribute mParticle Event Attribute Type Example Value
region.code region_code string "26"
region.name region_name string "Baltimore"
confidence confidence string "high"

user.exited_region_dma

Radar Event Attribute mParticle Event Attribute Type Example Value
region.code region_code string "26"
region.name region_name string "Baltimore"
confidence confidence string "high"