Data Reference H-L

Objects

HandheldCallingAnnotation

Kind: Object
Property
Type
Description
Nullable
type
'HandheldCallingAnnotation'
True
start
String
True
end
String
True
duration
Int
Duration is in milliseconds.
True

HandlingWithoutCallingAnnotation

Kind: Object
Property
Type
Description
Nullable
type
'HandlingWithoutCallingAnnotation'
True
start
String
True
end
String
True
duration
Int
Duration is in milliseconds.
True

HandsfreeCallingAnnotation

Kind: Object
Property
Type
Description
Nullable
type
'HandsfreeCallingAnnotation'
True
start
String
True
end
String
True
duration
Int
Duration is in milliseconds.
True

IAggregatedAnomaly

Kind: INTERFACE
Implemented by: AggregatedDistanceAnomaly, AggregatedDurationAnomaly, DayCountAnomaly, OccurrenceCountAnomaly An anomaly that we have detected for a user over a period of time.
Property
Type
Description
Nullable
period
Aggregation period over which the data is calculated.
True
day_part
DayPart
Optional additional aggregation over which the data is calculated.
True

IAnomaly

Kind: INTERFACE
Property
Type
Description
Nullable
type
'IAnomaly'
True
start
String
True
end
String
True
analysis_type
Deprecation notice analysis_type is deprecated. After significantly improving our platform's real-timeliness, we now don't need the analysis of a trip to go through multiple phases. This means you no longer need to filter our Firehose or API output by AnalysisType. Previously, trips had three analysis types based on processing latency. They were, namely, 'processed,' 'indepth,' and 'preliminary.' Based on your use cases, you may have filtered out certain types. As we will deprecate this field on Dec 10, 2021, you will need to change your backend if you use the AnalysisType field.
True
anomaly
Anomaly
True
sigma
Float
The observed standard deviation from expected behavior for this anomaly. If the standard deviation is high, the anomaly confidence will be low.
True
probability
Float
The larger the probability, the more anomaly. Value is between 0.0 and 1.0.
True

IBranchEvent

Kind: INTERFACE
Implemented by: StationaryPrediction, TransportPrediction A single predicted event.
Property
Type
Description
Nullable
start
String
Predicted start time of the event.
True
end
String
Predicted end time of the event.
True
probability
Float
The probability of this prediction occurring.
True
type
'IBranchEvent'
True

IDayCountAnomaly

Kind: INTERFACE
Implemented by: DayCountAnomaly
Property
Type
Description
Nullable
observed_days
Float
Observed amount of days.
True
expected_days
Float
Expected amount of days.
True

IDistanceAnomaly

Kind: INTERFACE
Property
Type
Description
Nullable
observed_distance
Float
Observed distance in meter.
True
expected_distance
Float
Expected distance in meter.
True

IDurationAnomaly

Kind: INTERFACE
Property
Type
Description
Nullable
observed_duration
Float
Observed duration in seconds.
True
expected_duration
Float
Expected duration in seconds.
True

IEvent

Kind: INTERFACE
Implemented by: Trip, Stationary, Transport An occurrence of an event that we have detected for a user. This interface is implemented by the Stationary and Transport models.
Property
Type
Description
Nullable
type
EventType
'IEvent'
True
event_id
String
False
previous_event_id
String
True
next_event_id
String
True
start
String
The time this moment started, ISO8601. Value can change and become more accurate over time. Example: 2015-05-28T14:37:14.839+00:00
True
end
String
The time this moment ended, ISO8601. Value can be null. Value can change and become more accurate over time. Example: 2015-05-28T14:37:14.839+00:00
True
start_ts
BigInt
True
end_ts
BigInt
True
analysis_type
How well this event is analyzed by the platform, this value will update over time. Possible values: preliminary, indepth, processed. Deprecation notice analysis_type is deprecated. After significantly improving our platform's real-timeliness, we now don't need the analysis of a trip to go through multiple phases. This means you no longer need to filter our Firehose or API output by AnalysisType. Previously, trips had three analysis types based on processing latency. They were, namely, 'processed,' 'indepth,' and 'preliminary.' Based on your use cases, you may have filtered out certain types. As we will deprecate this field on Dec 10, 2021, you will need to change your backend if you use the AnalysisType field.
True
weather
Weather data associated with this event.
True

IEventFeedback

Kind: INTERFACE
Implemented by: StationaryFeedback, TransportFeedback An occurrence of event feedback submitted by a user.
Property
Type
Description
Nullable
event_feedback
True

IEventPrediction

Kind: INTERFACE
Implemented by: StationaryIntervalPrediction, TransportIntervalPrediction An occurrence of an event prediction that we have detected for a user.
Property
Type
Description
Nullable
event_type
EventType
True

IFeedback

Kind: INTERFACE
Implemented by: StationaryFeedback, TransportFeedback, CrashFeedback, MomentFeedback An occurrence of feedback submitted by a user.
Property
Type
Description
Nullable
type
'IFeedback'
True
start
String
Start time the feedback relates to, sourced by the event, moment or user-provided.
False
end
String
End time the feedback relates to, sourced by the event, moment or user-provided.
True
created
String
Time when this feedback entry was created.
True
projection_time
String
Time to provide when the feedback data was read from the API. ISO8601. Optional.
True

IIntervalPrediction

Kind: INTERFACE
Implemented by: StationaryIntervalPrediction, TransportIntervalPrediction A prediction that has a start interval.
Property
Type
Description
Nullable
start_interval
True

IMoment

Kind: INTERFACE
Implemented by: GenericMoment, CityMoment, CountryMoment An occurrence of a MomentDefinition that we have detected for a user.
Property
Type
Description
Nullable
type
'IMoment'
True
start
String
The time this moment started, ISO8601. Value can change and become more accurate over time. Example: 2015-05-28T14:37:14.839+00:00
True
end
String
The time this moment ended, ISO8601. Value can be null. Value can change and become more accurate over time. Example: 2015-05-28T14:37:14.839+00:00
True
start_ts
BigInt
True
end_ts
BigInt
True
analysis_type
How well this moment is analyzed by the platform, this value will update over time. Possible values: preliminary, indepth, processed. Deprecation notice analysis_type is deprecated. After significantly improving our platform's real-timeliness, we now don't need the analysis of a trip to go through multiple phases. This means you no longer need to filter our Firehose or API output by AnalysisType. Previously, trips had three analysis types based on processing latency. They were, namely, 'processed,' 'indepth,' and 'preliminary.' Based on your use cases, you may have filtered out certain types. As we will deprecate this field on Dec 10, 2021, you will need to change your backend if you use the AnalysisType field.
True
moment_definition_id
String
The ID of the MomentDefinition this moment relates to.
True
moment_definition
The MomentDefinition this moment relates to.
True

IMomentAnomaly

Kind: INTERFACE
Property
Type
Description
Nullable
moment_definition_id
String
True

IMomentFeedback

Kind: INTERFACE
Implemented by: MomentFeedback An occurrence of moment feedback submitted by a user.
Property
Type
Description
Nullable
moment_feedback
True

IOccurrenceCountAnomaly

Kind: INTERFACE
Implemented by: OccurrenceCountAnomaly
Property
Type
Description
Nullable
observed_occurrences
Float
Observed amount of occurrences.
True
expected_occurrences
Float
Expected amount of occurrences.
True

IPrediction

Kind: INTERFACE
Implemented by: StationaryIntervalPrediction, TransportIntervalPrediction An occurance of a prediction that we have detected for a user.
Property
Type
Description
Nullable
type
'IPrediction'
True
probability
Float
True

ISegment

Kind: INTERFACE
Implemented by: GenericSegment An occurrence of a SegmentDefinition that we have detected for this user.
Property
Type
Description
Nullable
type
'ISegment'
True
segment_definition_id
String
The ID of the SegmentDefinition this segment relates to.
True
segment_definition
The SegmentDefinition this segment relates to.
True

IStationaryAnomaly

Kind: INTERFACE
Property
Type
Description
Nullable
place_category
String
True
location_significance
True

ITimeAggregateAttribute

Kind: INTERFACE
Implemented by: CommuteTimeAggregate, StationaryTimeAggregate, TransportTimeAggregate, WorkingTimeAggregate An attribute that aggregates by TimePeriod.
Property
Type
Description
Nullable
period
True

ITransportAnomaly

Kind: INTERFACE
Property
Type
Description
Nullable
transport_mode
True
transport_mode_category
True

ITransportBehaviorAnnotation

Kind: INTERFACE
Property
Type
Description
Nullable
type
'ITransportBehaviorAnnotation'
True
start
String
True
end
String
True

IUser

Kind: INTERFACE
Implemented by: User, ControlUser
Property
Type
Description
Nullable
type
UserType
'IUser'
True
id
String
The unique identifier for this user.
True
can_login
Boolean
True
created_at
String
The time when this user was created, ISO8601. Example: 2015-05-28T14:37:14.839+00:00
True
sdk
True
application_id
String
The ID of the Application this user relates to.
True
application
The Application this user relates to.
True
custom_event_history
Custom Event History
True
event_history
IEvent
An unordered list of events we have detected for this user.
True
car_behavior
The user car behavior aggregated over the last 9 weeks.
True
aggregated_driving_scores
True
transport_heatmaps
The aggregated transport heatmaps calculated over time. Deprecation notice transport_heatmaps is deprecated. No longer used.
True
metadata
JSON
All custom set metadata properties on this user. This is a JSON object with key->value pairs.
True
device
The last known active tracking device metadata
True
active_moments
IMoment
An unordered list of moments that are ongoing from the point of view of the platform.
True
moment_history
IMoment
An unordered list of moments we have detected for this user.
True
semantic_time
The user's semantic time averaged over time.
True
anomaly_history
IAnomaly
Deprecation notice anomaly_history is deprecated. No longer relevant.
True
segments
ISegment
An unordered list of segments that are detected for this user.
True
location_clusters
Locations this user has been stationary at and the features we have learned about those locations (significance, point of interest, ...)
True
location
Waypoint
The last known location we have for this user.
True
health
The historical health attributes. Deprecation notice health is deprecated. No longer supported
True
attributes
Deprecation notice attributes is deprecated. No longer supported.
True
predictions
Event/Moment predictions for this user Deprecation notice predictions is deprecated. Please use prediction_tree.
True
prediction_tree
Multiple possible predictions of events that are about to take place next. They are ordered by the highest probability of each sequence of events taking place.
True
feedback
IFeedback
Feedback on this user Deprecation notice feedback is deprecated. Replaced by feedback_history
True
feedback_history
IFeedback
Feedback on this user
True
step_count
Step count details of the given user on the given date range. This feature is currently in Beta, for additional information contact [email protected]
True

IUserAttribute

Kind: INTERFACE
Property
Type
Description
Nullable
type
'IUserAttribute'
True

InputAddress

Kind: INPUT_OBJECT

InputCrash

Kind: INPUT_OBJECT

InputCrashFeedback

Kind: INPUT_OBJECT

InputEventFeedback

Kind: INPUT_OBJECT

InputLocationPlaceCandidate

Kind: INPUT_OBJECT

InputMoment

Kind: INPUT_OBJECT

InputMomentFeedback

Kind: INPUT_OBJECT

InputOndeviceMLModel

Kind: INPUT_OBJECT
Name of the models that were used to detect the crash. Mainly used as internal reference.

InputStationary

Kind: INPUT_OBJECT

InputStationaryLocation

Kind: INPUT_OBJECT

InputTrajectoryWaypoint

Kind: INPUT_OBJECT
A single waypoint in the augmented trajectory.

InputTransport

Kind: INPUT_OBJECT

InputTransportBehaviorFeatures

Kind: SCALAR

InputTransportBehaviorScores

Kind: SCALAR

InputTransportTrajectory

Kind: INPUT_OBJECT

InputWaypoint

Kind: INPUT_OBJECT

JSON

Kind: SCALAR
The JSON scalar type represents JSON values as specified by ECMA-404.

LocationCluster

Kind: Object
Property
Type
Description
Nullable
type
String
'LocationCluster'
True
last_visit
String
True
latitude
Float
True
longitude
Float
True
address
Address
True
radius
Int
True
is_poi
Boolean
True
significance
True
place
True

LocationPlaceCandidate

Kind: Object
A place selected from one of our data sources.
Property
Type
Description
Nullable
type
String
'LocationPlaceCandidate'
True
name
String
Name of the place. Can be null if no specific place can be assigned.
True
categories
String
List of categories for this place, sorted by granularity. Categories might still be provided when name is null, for example when shopping in a shopping street, categories like shopping and retail can still exist. Deprecation notice categories is deprecated. These are outdated. Please use category_hierarchy instead.
True
category_hierarchy
String
A list of venue categories in hierarchical order. The first item represents the broadest category, with each subsequent item representing a more specific one. For ex. ["shop","food","grocery","supermarket"]
True
probability
Float
True
latitude
Float
True
longitude
Float
True
provider
String
True

LocationSignificance

Kind: ENUM
  • home: A location identified as one of the user's home locations.
  • work: A location identified as one of the user's work locations.
  • regular: Locations you regularly visit. Typical examples are places you regularly go shopping, your gym, a friend's place, ...
  • nonregular: Default type for locations you don't often visit.
  • poi: Points of interest that have not been classified as home/work previously.
  • new: Only available a short time when you visit the location the first time.
Copy link
On this page
Objects
HandheldCallingAnnotation
HandlingWithoutCallingAnnotation
HandsfreeCallingAnnotation
IAggregatedAnomaly
IAnomaly
IBranchEvent
IDayCountAnomaly
IDistanceAnomaly
IDurationAnomaly
IEvent
IEventFeedback
IEventPrediction
IFeedback
IIntervalPrediction
IMoment
IMomentAnomaly
IMomentFeedback
IOccurrenceCountAnomaly
IPrediction
ISegment
IStationaryAnomaly
ITimeAggregateAttribute
ITransportAnomaly
ITransportBehaviorAnnotation
IUser
IUserAttribute
InputAddress
InputCrash
InputCrashFeedback
InputEventFeedback
InputLocationPlaceCandidate
InputMoment
InputMomentFeedback
InputOndeviceMLModel
InputStationary
InputStationaryLocation
InputTrajectoryWaypoint
InputTransport
InputTransportBehaviorFeatures
InputTransportBehaviorScores
InputTransportTrajectory
InputWaypoint
JSON
LocationCluster
LocationPlaceCandidate
LocationSignificance