Skip to main content
Represents a change in user state. Events are generated when a user enters or exits a geofence, place, region, or beacon, or when trip status changes.

​
Properties

​
String
required
The Radar ID of the event.
​
Date
required
The datetime when the event occurred on the device.
​
Date
required
The datetime when the event was created on the server.
​
Bool
required
A boolean indicating whether the event was generated with your live API key.
​
RadarEventType
required
The type of the event. See Event Types for possible values.
​
String
The name of the conversion event. This will only be set if the type is conversion.
​
RadarGeofence
The geofence for which the event was generated. May be nil for non-geofence events.
​
RadarPlace
The place for which the event was generated. May be nil for non-place events.
​
RadarRegion
The region for which the event was generated. May be nil for non-region events.
​
RadarBeacon
The beacon for which the event was generated. May be nil for non-beacon events.
​
RadarTrip
The trip for which the event was generated. May be nil for non-trip events.
​
RadarFraud
The fraud checks for which the event was generated. May be nil for non-fraud events.
​
[RadarPlace]
For place entry events, alternate place candidates. May be nil for non-place events.
​
RadarPlace
For accepted place entry events, the verified place. May be nil for non-place events or unverified events.
​
RadarEventVerification
required
The verification of the event. See Event Verification for possible values.
​
RadarEventConfidence
required
The confidence level of the event. See Event Confidence for possible values.
​
Float
required
The duration between entry and exit events, in minutes, for exit events. 0 for entry events.
​
CLLocation
required
The location of the event.
​
Bool
required
A boolean indicating whether the event came from a replayed location.
​
[String: Any]
required
The metadata of the event. Present on conversion events only.

​
Event Types

The RadarEventType enum defines the types of events that can be generated:
​
RadarEventType
Unknown event type.
​
RadarEventType
A conversion type, created by calling Radar.sendEvent(). The type value will be assigned to the conversionName property.
​
RadarEventType
user.entered_geofence - User entered a geofence.
​
RadarEventType
user.exited_geofence - User exited a geofence.
​
RadarEventType
user.entered_place - User entered a place.
​
RadarEventType
user.exited_place - User exited a place.
​
RadarEventType
user.nearby_place_chain - User is near a place chain.
​
RadarEventType
user.entered_region_country - User entered a country.
​
RadarEventType
user.exited_region_country - User exited a country.
​
RadarEventType
user.entered_region_state - User entered a state.
​
RadarEventType
user.exited_region_state - User exited a state.
​
RadarEventType
user.entered_region_dma - User entered a designated market area (DMA).
​
RadarEventType
user.exited_region_dma - User exited a DMA.
​
RadarEventType
user.entered_region_postal_code - User entered a postal code.
​
RadarEventType
user.exited_region_postal_code - User exited a postal code.
​
RadarEventType
user.dwelled_in_geofence - User dwelled in a geofence.
​
RadarEventType
user.started_trip - User started a trip.
​
RadarEventType
user.updated_trip - User’s trip was updated.
​
RadarEventType
user.approaching_trip_destination - User is approaching the trip destination.
​
RadarEventType
user.arrived_at_trip_destination - User arrived at the trip destination.
​
RadarEventType
user.arrived_at_wrong_trip_destination - User arrived at the wrong trip destination.
​
RadarEventType
user.stopped_trip - User stopped a trip.
​
RadarEventType
user.fired_trip_orders - User fired trip orders.
​
RadarEventType
user.entered_beacon - User entered a beacon region.
​
RadarEventType
user.exited_beacon - User exited a beacon region.
​
RadarEventType
user.failed_fraud - User failed fraud detection checks.

​
Event Confidence

The RadarEventConfidence enum defines the confidence levels for events:
​
RadarEventConfidence
Unknown confidence (0).
​
RadarEventConfidence
Low confidence (1).
​
RadarEventConfidence
Medium confidence (2).
​
RadarEventConfidence
High confidence (3).

​
Event Verification

The RadarEventVerification enum defines the verification types for events:
​
RadarEventVerification
Accept event (1).
​
RadarEventVerification
Unverify event (0).
​
RadarEventVerification
Reject event (-1).

​
Methods

​
stringForType

Converts a RadarEventType enum value to its string representation.
​
RadarEventType
required
The event type to convert.
Returns: The string representation of the event type, or nil if unknown.

​
dictionaryValue

Converts the event to a dictionary representation. Returns: A dictionary representation of the event.

​
arrayForEvents

Converts an array of events to an array of dictionary representations.
​
[RadarEvent]
The array of events to convert.
Returns: An array of dictionary representations, or nil if the input is nil.

​
See Also