Data Reference Q-T

Objects
​SegmentDefinition​
​SemanticTimeAggregate​
​SemanticTimeAggregateValue​
​Stationary​
​StationaryFeedback​
​StationaryIntervalPrediction​
​StationaryLocation​
​StationaryPrediction​
​StationaryTimeAggregate​
​TimeWindowTransportHeatmaps​
​TimeWindowUserCarBehaviorFeatures​
​TrajectoryWaypoint​
​Transport​
​TransportAddress​
​TransportAddresses​
​TransportFeedback​
​TransportHeatmaps​
​TransportIntervalPrediction​
​TransportModeHeatmaps​
​TransportPrediction​
​TransportTimeAggregate​
​TransportTrajectory​
​Trip​
​TripConnection​
​TurnBehaviorAnnotation​
SdkFlavor
Kind: ENUM
full
offline_driving
realtime_marketing
offline_segmentation
triggered_trips
SegmentDefinition
Kind: Object​
A single segment definition.
Property
Type
Description
Nullable
type
String
'SegmentDefinition'
True
id
String
Identifier for this segment.
True
version
Int
Version which will increase everytime minor changes or improvements happen to the calculation of this segment.
True
category
String
Category of this segment, if any.
True
subcategory
String
Subcategory of this segment, if any.
True
display_name
String
A displayable name for this segment.
True
description
String
A short description about this segment.
True
deprecated
Boolean
Flag that indicates if this segment will be removed in one of the following releases. Do not use segments that are marked deprecated for new development.
True
deprecated_at
String
Date when the segment will be removed. Default null.
True
SegmentDefinitionStatus
Kind: ENUM
ACTIVE: The current active version of segment definitions.
ALPHA: The next version of segment definitions, these will become active in the next release. Identifies the release status of a segment definition.
SegmentType
Kind: ENUM
GenericSegment
SemanticTime
Kind: ENUM
morning
lunch
afternoon
evening
night The user semantic time.
SemanticTimeAggregate
Kind: Object​
Property
Type
Description
Nullable
type
String
'SemanticTimeAggregate'
True
morning
​SemanticTimeAggregateValue​
​
True
lunch
​SemanticTimeAggregateValue​
​
True
afternoon
​SemanticTimeAggregateValue​
​
True
evening
​SemanticTimeAggregateValue​
​
True
night
​SemanticTimeAggregateValue​
​
True
SemanticTimeAggregateDaysEnum
Kind: ENUM
all_days: All days are used in the calculation of the aggregate.
SemanticTimeAggregateValue
Kind: Object​
Property
Type
Description
Nullable
type
String
'SemanticTimeAggregateValue'
True
semantic_time
​SemanticTime​
​
True
days
​SemanticTimeAggregateDaysEnum​
​
True
start
String
The average start time of the semantic time, in local time, ISO 8601 time format, second precision. Example: 15:34:00
True
end
String
The average end time of the semantic time, in local time, ISO 8601 time format, second precision. Example: 15:34:00
True
Stationary
Kind: Object​
Implements: IEvent​
Property
Type
Description
Nullable
type
​EventType​
'Stationary'
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
​AnalysisType​
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
latitude
Float
​
True
longitude
Float
​
True
duration
​BigInt​
​
True
address
​Address​
​
True
location
​StationaryLocation​
​
True
weather
​WeatherRange​
Weather data associated with this event.
True
StationaryFeedback
Kind: Object​
Implements: IFeedback, IEventFeedback​
Property
Type
Description
Nullable
type
​FeedbackType​
'StationaryFeedback'
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
event_feedback
​EventFeedback​
​
True
stationary
​Stationary​
The Stationary this feedback refers to.
True
StationaryIntervalPrediction
Kind: Object​
Implements: IPrediction, IEventPrediction, IIntervalPrediction​
Property
Type
Description
Nullable
type
​PredictionType​
'StationaryIntervalPrediction'
True
probability
Float
​
True
event_type
​EventType​
​
True
start_interval
​PredictionInterval​
​
True
location
​StationaryLocation​
​
True
StationaryLocation
Kind: Object​
Holds more information about a stationary location.
Property
Type
Description
Nullable
type
String
'StationaryLocation'
True
significance
​LocationSignificance​
What this location means for the user, or the frequency it's being visited.
True
place
​LocationPlaceCandidate​
​
True
place_candidates
​LocationPlaceCandidate​
​
True
StationaryPrediction
Kind: Object​
Implements: IBranchEvent​
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
​TreePredictionType​
'StationaryPrediction'
True
location_type
String
​
True
significance
String
​
True
place
​LocationPlaceCandidate​
​
True
StationaryTimeAggregate
Kind: Object​
Implements: ITimeAggregateAttribute, IUserAttribute​
Property
Type
Description
Nullable
type
​UserAttributeType​
'StationaryTimeAggregate'
True
period
​TimePeriod​
​
True
duration
Float
​
True
place_category
String
​
True
location_significance
​LocationSignificance​
​
True
TimePeriod
Kind: ENUM
week
TimeWindowTransportHeatmaps
Kind: Object​
Property
Type
Description
Nullable
type
String
'TimeWindowTransportHeatmaps'
True
car
​TransportModeHeatmaps​
​
True
TimeWindowUserCarBehaviorFeatures
Kind: Object​
Property
Type
Description
Nullable
type
String
'TimeWindowUserCarBehaviorFeatures'
True
phone_handling
Float
The average number of milliseconds this user is using his phone per hour in transport, during this time window.
True
distance
Int
Aggregated distance measured in meter for all car transports during this time window.
True
TrajectoryWaypoint
Kind: Object​
A single waypoint in the augmented trajectory.
Property
Type
Description
Nullable
type
String
'TrajectoryWaypoint'
True
latitude
Float
​
True
longitude
Float
​
True
timestamp
String
​
True
road_type
String
​
True
speed
Float
The average speed between this waypoint and the next waypoint, in km/h.

Deprecation notice
speed is deprecated.
Deprecated in favor of speed_v2.
True
speed_v2
Float
The average speed between this waypoint and the next waypoint, in km/h. The difference with speed is that it has an improved estimation algorithm.
True
speed_v2_confidence
Float
This field gives confidence for our speed estimation based on the actual sampling rate of the waypoints and if there are multi-speed zones in the road segments between 2 actual waypoints. Values can range from 1.00-0.50.
1.00 will be assigned for those GPS waypoint with instantaneous speed.

0.95 will be assigned for those GPS waypoint with no instantaneous speed.

0.5 will be assigned for the augmented waypoints with the least confidence which includes those segments with more than 5 minutes between the real waypoints and where the average speed is within the (combined) speed limits of the trip but we still report speeding.
True
distance
Float
The distance in meter between the current waypoint and the next waypoint.
True
speed_limit
Float
Speed limit (in km/h) measured at this point in the trajectory as provided by our mapping data partners.
True
Transport
Kind: Object​
Implements: IEvent​
Property
Type
Description
Nullable
type
​EventType​
'Transport'
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
​AnalysisType​
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
session_ids
​String​
A list of sessionIDs from the SDK that can be used to correlate data in sensor-offloads.
True
mode
​TransportMode​
The transport mode that was identified for this transport.
True
distance
Int
Distance is in meters.
True
occupant_role
​TransportOccupantRole​
​
True
waypoints
​Waypoint​
​
True
trajectory
​TransportTrajectory​
​
True
behavior_scores
​TransportBehaviorScores​
​
True
behavior_annotations
​ITransportBehaviorAnnotation​
​
True
behavior_features
​TransportBehaviorFeatures​
​
True
addresses
​TransportAddresses​
​
True
weather
​WeatherRange​
Weather data associated with this event.
True
TransportAddress
Kind: Object​
An Address describes a reverse geocoded location. All the fields are retrieved from Open Street Map and all names are subject to whatever data has been provided in said map.
Property
Type
Description
Nullable
type
String
'TransportAddress'
True
street
String
​
True
city
String
​
True
city_type
String
​
True
district
String
​
True
region
String
​
True
country
String
​
True
TransportAddresses
Kind: Object​
Details of the origin and destination locations of a Transport.
Property
Type
Description
Nullable
origin
​TransportAddress​
​
True
destination
​TransportAddress​
​
True
TransportBehaviorAnnotationType
Kind: ENUM
AccelerationBehaviorAnnotation
BoundaryBehaviorAnnotation
AnomalyBehaviorAnnotation
TurnBehaviorAnnotation
HandlingWithoutCallingAnnotation
HandsfreeCallingAnnotation
HandheldCallingAnnotation
CrashAnnotation
TransportBehaviorFeatures
Kind: UNION
Possible types: CarBehaviorFeatures​
TransportBehaviorScores
Kind: UNION
Possible types: CarBehaviorScores The transport behavior scores we have detected during a transport. These scores are only available when the full trip is processed.
TransportFeedback
Kind: Object​
Implements: IFeedback, IEventFeedback​
Property
Type
Description
Nullable
type
​FeedbackType​
'TransportFeedback'
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

Property	Type	Description	Nullable
type	String	'SegmentDefinition'	True
id	String	Identifier for this segment.	True
version	Int	Version which will increase everytime minor changes or improvements happen to the calculation of this segment.	True
category	String	Category of this segment, if any.	True
subcategory	String	Subcategory of this segment, if any.	True
display_name	String	A displayable name for this segment.	True
description	String	A short description about this segment.	True
deprecated	Boolean	Flag that indicates if this segment will be removed in one of the following releases. Do not use segments that are marked deprecated for new development.	True
deprecated_at	String	Date when the segment will be removed. Default null.	True

Property	Type	Description	Nullable
type	String	'SemanticTimeAggregate'	True
morning	SemanticTimeAggregateValue		True
lunch	SemanticTimeAggregateValue		True
afternoon	SemanticTimeAggregateValue		True
evening	SemanticTimeAggregateValue		True
night	SemanticTimeAggregateValue		True

Property	Type	Description	Nullable
type	String	'SemanticTimeAggregateValue'	True
semantic_time	SemanticTime		True
days	SemanticTimeAggregateDaysEnum		True
start	String	The average start time of the semantic time, in local time, ISO 8601 time format, second precision. Example: 15:34:00	True
end	String	The average end time of the semantic time, in local time, ISO 8601 time format, second precision. Example: 15:34:00	True

Property	Type	Description	Nullable
type	EventType	'Stationary'	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	AnalysisType	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
latitude	Float		True
longitude	Float		True
duration	BigInt		True
address	Address		True
location	StationaryLocation		True
weather	WeatherRange	Weather data associated with this event.	True

Property	Type	Description	Nullable
type	FeedbackType	'StationaryFeedback'	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
event_feedback	EventFeedback		True
stationary	Stationary	The Stationary this feedback refers to.	True

Property	Type	Description	Nullable
type	PredictionType	'StationaryIntervalPrediction'	True
probability	Float		True
event_type	EventType		True
start_interval	PredictionInterval		True
location	StationaryLocation		True

Property	Type	Description	Nullable
type	String	'StationaryLocation'	True
significance	LocationSignificance	What this location means for the user, or the frequency it's being visited.	True
place	LocationPlaceCandidate		True
place_candidates	LocationPlaceCandidate		True

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	TreePredictionType	'StationaryPrediction'	True
location_type	String		True
significance	String		True
place	LocationPlaceCandidate		True

Property	Type	Description	Nullable
type	UserAttributeType	'StationaryTimeAggregate'	True
period	TimePeriod		True
duration	Float		True
place_category	String		True
location_significance	LocationSignificance		True

Property	Type	Description	Nullable
type	String	'TimeWindowTransportHeatmaps'	True
car	TransportModeHeatmaps		True

Property	Type	Description	Nullable
type	String	'TimeWindowUserCarBehaviorFeatures'	True
phone_handling	Float	The average number of milliseconds this user is using his phone per hour in transport, during this time window.	True
distance	Int	Aggregated distance measured in meter for all car transports during this time window.	True

Property	Type	Description	Nullable
type	String	'TrajectoryWaypoint'	True
latitude	Float		True
longitude	Float		True
timestamp	String		True
road_type	String		True
speed	Float	The average speed between this waypoint and the next waypoint, in km/h. `Deprecation notice` speed is deprecated. Deprecated in favor of `speed_v2`.	True
speed_v2	Float	The average speed between this waypoint and the next waypoint, in km/h. The difference with speed is that it has an improved estimation algorithm.	True
speed_v2_confidence	Float	This field gives confidence for our speed estimation based on the actual sampling rate of the waypoints and if there are multi-speed zones in the road segments between 2 actual waypoints. Values can range from 1.00-0.50. 1.00 will be assigned for those GPS waypoint with instantaneous speed. 0.95 will be assigned for those GPS waypoint with no instantaneous speed. 0.5 will be assigned for the augmented waypoints with the least confidence which includes those segments with more than 5 minutes between the real waypoints and where the average speed is within the (combined) speed limits of the trip but we still report speeding.	True
distance	Float	The distance in meter between the current waypoint and the next waypoint.	True
speed_limit	Float	Speed limit (in km/h) measured at this point in the trajectory as provided by our mapping data partners.	True

Property	Type	Description	Nullable
type	EventType	'Transport'	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	AnalysisType	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
session_ids	String	A list of sessionIDs from the SDK that can be used to correlate data in sensor-offloads.	True
mode	TransportMode	The transport mode that was identified for this transport.	True
distance	Int	Distance is in meters.	True
occupant_role	TransportOccupantRole		True
waypoints	Waypoint		True
trajectory	TransportTrajectory		True
behavior_scores	TransportBehaviorScores		True
behavior_annotations	ITransportBehaviorAnnotation		True
behavior_features	TransportBehaviorFeatures		True
addresses	TransportAddresses		True
weather	WeatherRange	Weather data associated with this event.	True

Property	Type	Description	Nullable
type	String	'TransportAddress'	True
street	String		True
city	String		True
city_type	String		True
district	String		True
region	String		True
country	String		True

Property	Type	Description	Nullable
type	FeedbackType	'TransportFeedback'	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