Data Reference Q-Z
​SegmentDefinition​
​SemanticTimeAggregate​
​Stationary​
​StationaryFeedback​
​StationaryLocation​
​StationaryPrediction​
​StationaryTimeAggregate​
​TrajectoryWaypoint​
​Transport​
​TransportFeedback​
​TransportHeatmaps​
​TransportModeHeatmaps​
​TransportPrediction​
​TransportTimeAggregate​
​TransportTrajectory​
​Trip​
​TripConnection​
​TurnBehaviorAnnotation​
​User​
​UserAccountRole​
​UserCarBehavior​
​UserCarBehaviorFeatures​
​UserCarBehaviorScores​
​UserHealth​
​UserHealthScores​
​UserSdkSettings​
​UserSemanticTime​
​UserTimeAggregatedScores​
​UsersConnection​
​Waypoint​
​Weather​
​WeatherRange​
​WeightedLocation​
​WorkingTimeAggregate​
​ZoneCarBehaviorScores​
Kind: ENUM
full
offline_driving
realtime_marketing
offline_segmentation
triggered_trips
Kind: Object​
A single segment definition.
Property | Type | Description |
type | String | 'SegmentDefinition' |
id | String | Identifier for this segment. |
version | Int | Version which will increase everytime minor changes or improvements happen to the calculation of this segment. |
category | String | Category of this segment, if any. |
subcategory | String | Subcategory of this segment, if any. |
display_name | String | A displayable name for this segment. |
description | String | A short description about this segment. |
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. |
deprecated_at | String | Date when the segment will be removed. Default null. |
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.
Kind: ENUM
GenericSegment
Kind: ENUM
morning
lunch
afternoon
evening
night
The user semantic time.
Kind: Object​
Property | Type | Description |
type | String | 'SemanticTimeAggregate' |
morning | ​ | |
lunch | ​ | |
afternoon | ​ | |
evening | ​ | |
night | ​ |
Kind: ENUM
all_days: All days are used in the calculation of the aggregate.
Kind: Object​
Property | Type | Description |
type | String | 'SemanticTimeAggregateValue' |
semantic_time | ​SemanticTime​ | ​ |
days | ​ | |
start | String | The average start time of the semantic time, in local time, ISO 8601 time format, second precision. Example: 15:34:00 |
end | String | The average end time of the semantic time, in local time, ISO 8601 time format, second precision. Example: 15:34:00 |
Kind: Object​
Implements: IEvent​
Property | Type | Description |
type | ​EventType​ | 'Stationary' |
previous_event_id | String | ​ |
next_event_id | String | ​ |
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 |
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 |
start_ts | ​BigInt​ | ​ |
end_ts | ​BigInt​ | ​ |
analysis_type | ​AnalysisType​ | How well this event is analyzed by the platform, this value will update over time. Possible values: preliminary, indepth, processed. |
latitude | Float | ​ |
longitude | Float | ​ |
duration | ​BigInt​ | ​ |
address | ​Address​ | ​ |
location | ​StationaryLocation​ | ​ |
weather | ​WeatherRange​ | Weather data associated with this event. |
Kind: Object​
Implements: IFeedback, IEventFeedback​
Property | Type | Description |
type | ​FeedbackType​ | 'StationaryFeedback' |
end | String | End time the feedback relates to, sourced by the event, moment or user-provided. |
created | String | Time when this feedback entry was created. |
projection_time | String | Time to provide when the feedback data was read from the API. ISO8601. Optional. |
event_feedback | ​EventFeedback​ | ​ |
stationary | ​Stationary​ | The Stationary this feedback refers to. |
Kind: Object​
Implements: IPrediction, IEventPrediction, IIntervalPrediction​
Property | Type | Description |
type | ​PredictionType​ | 'StationaryIntervalPrediction' |
probability | Float | ​ |
event_type | ​EventType​ | ​ |
start_interval | ​PredictionInterval​ | ​ |
location | ​StationaryLocation​ | ​ |
Kind: Object​
Holds more information about a stationary location.
Property | Type | Description |
type | String | 'StationaryLocation' |
significance | ​LocationSignificance​ | What this location means for the user, or the frequency it's being visited. |
place | ​LocationPlaceCandidate​ | ​ |
place_candidates | ​LocationPlaceCandidate​ | ​ |
Kind: Object​
Implements: IBranchEvent​
Property | Type | Description |
start | String | Predicted start time of the event. |
end | String | Predicted end time of the event. |
probability | Float | The probability of this prediction occurring. |
type | ​TreePredictionType​ | 'StationaryPrediction' |
location_type | String | ​ |
significance | String | ​ |
place | ​LocationPlaceCandidate​ | ​ |
Kind: Object​
Implements: ITimeAggregateAttribute, IUserAttribute​
Property | Type | Description |
type | ​UserAttributeType​ | 'StationaryTimeAggregate' |
period | ​TimePeriod​ | ​ |
duration | Float | ​ |
place_category | String | ​ |
location_significance | ​LocationSignificance​ | ​ |
Kind: ENUM
week
Kind: Object​
Property | Type | Description |
type | String | 'TimeWindowTransportHeatmaps' |
car | ​TransportModeHeatmaps​ | ​ |
Kind: Object​
Property | Type | Description |
type | String | 'TimeWindowUserCarBehaviorFeatures' |
phone_handling | Float | The average number of milliseconds this user is using his phone per hour in transport, during this time window. |
distance | Int | Aggregated distance measured in meter for all car transports during this time window. |
Kind: Object​
A single waypoint in the augmented trajectory.
Property | Type | Description |
type | String | 'TrajectoryWaypoint' |
latitude | Float | ​ |
longitude | Float | ​ |
timestamp | String | ​ |
road_type | String | ​ |
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. |
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. |
distance | Float | The distance in meter between the current waypoint and the next waypoint. |
speed_limit | Float | Speed limit (in km/h) measured at this point in the trajectory as provided by our mapping data partners. |
Kind: Object​
Implements: IEvent​
Property | Type | Description |
type | ​EventType​ | 'Transport' |
previous_event_id | String | ​ |
next_event_id | String | ​ |
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 |
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 |
start_ts | ​BigInt​ | ​ |
end_ts | ​BigInt​ | ​ |
analysis_type | ​AnalysisType​ | How well this event is analyzed by the platform, this value will update over time. Possible values: preliminary, indepth, processed. |
session_ids | ​String​ | A list of sessionIDs from the SDK that can be used to correlate data in sensor-offloads. |
mode | ​TransportMode​ | The transport mode that was identified for this transport. |
distance | Int | Distance is in meters. |
occupant_role | ​TransportOccupantRole​ | ​ |
waypoints | ​Waypoint​ | ​ |
trajectory | ​TransportTrajectory​ | ​ |
behavior_scores | ​TransportBehaviorScores​ | ​ |
behavior_annotations | ​ | |
behavior_features | ​ | |
weather | ​WeatherRange​ | Weather data associated with this event. |
Kind: ENUM
AccelerationBehaviorAnnotation
BoundaryBehaviorAnnotation
AnomalyBehaviorAnnotation
TurnBehaviorAnnotation
HandlingWithoutCallingAnnotation
HandsfreeCallingAnnotation
HandheldCallingAnnotation
Kind: UNION
Possible types: CarBehaviorFeatures​
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.
Kind: Object​
Implements: IFeedback, IEventFeedback​
Property | Type | Description |
type | ​FeedbackType​ | 'TransportFeedback' |
end | String | End time the feedback relates to, sourced by the event, moment or user-provided. |
created | String | Time when this feedback entry was created. |
projection_time | String | Time to provide when the feedback data was read from the API. ISO8601. Optional. |
event_feedback | ​EventFeedback​ | ​ |
transport | ​Transport​ | The Transport this feedback refers to. |
Kind: Object​
Historically aggregated transport heatmaps.
Property | Type | Description |
type | String | 'TransportHeatmaps' |
l30d | Transport heatmaps that are calculated using the last . |
Kind: Object​
Implements: IPrediction, IEventPrediction, IIntervalPrediction​
Property | Type | Description |
type | ​PredictionType​ | 'TransportIntervalPrediction' |
probability | Float | ​ |
event_type | ​EventType​ | ​ |
start_interval | ​PredictionInterval​ | ​ |
mode | ​TransportMode​ | ​ |
Kind: ENUM
car: When we have identified a transport mode as car.
walking: When we have identified a transport mode as walking.
biking: When we have identified a transport mode as biking.
escooter: When we have identified a transport mode as escooter.
train: When we have identified a transport mode as train.
bus: When we have identified a transport mode as bus.
tram: When we have identified a transport mode as tram.
subway: When we have identified a transport mode as subway/underground/metro.
boat: When we have identified a transport mode as boat.
ferry: When we have identified a transport mode as ferry.
motorcycle: When we have identified a transport mode as motorcycle.
flight: When we have identified a transport mode as flight. This is currently only available for processed results.
running: When we have identified a transport mode as running. This is currently only available for preliminary results.
idle: When a transport is identified as idle behavior.
other: When a transport is identified as other transport mode.
insufficient_data: When we don't have enough data to identify a transport mode.
The transport modes the platform supports.
Kind: ENUM
unknown
healthy
unhealthy
Kind: Object​
Property | Type | Description |
type | String | 'TransportModeHeatmaps' |
passed | ​WeightedLocation​ | An aggregate heatmap based on the amounts of times you have passed the coordinates during transports. |
Kind: ENUM
driver
passenger
unknown
Kind: Object​
Implements: IBranchEvent​
Property | Type | Description |
start | String | Predicted start time of the event. |
end | String | Predicted end time of the event. |
probability | Float | The probability of this prediction occurring. |
type | ​TreePredictionType​ | 'TransportPrediction' |
mode | String | ​ |
Kind: Object​
Implements: ITimeAggregateAttribute, IUserAttribute​
Property | Type | Description |
type | ​UserAttributeType​ | 'TransportTimeAggregate' |
period | ​TimePeriod​ | ​ |
duration | Float | ​ |
mode | ​TransportMode​ | ​ |
Kind: Object​
Property | Type | Description |
type | String | 'TransportTrajectory' |
waypoints | ​TrajectoryWaypoint​ | ​ |
encoded | String | An encoded list of trajectory waypoints, [[lat,lon],[lat,lon]]. More info on polyline decoding: https://developers.google.com/maps/documentation/utilities/polylinealgorithm​ |
Kind: ENUM
StationaryPrediction: Prediction of a Stationary event.
TransportPrediction: Prediction of a Transport event.
Kind: Object​
Implements: IEvent​
Property | Type | Description |
type | ​EventType​ | 'Trip' |
previous_event_id | String | ​ |
next_event_id | String | ​ |
user_id | String | ​ |
start | String | ​ |
end | String | ​ |
start_ts | ​BigInt​ | ​ |
end_ts | ​BigInt​ | ​ |
mode | String | Car, tram, walking, etc. |
analysis_type | ​AnalysisType​ | Type of processing applied on the trip. |
behavior_scores | ​CarBehaviorScores​ | ​ |
weather | ​WeatherRange​ | ​ |
Kind: Object​
Access trips across all users.
Property | Type | Description |
type | String | 'TripConnection' |
slice | ​Trip​ | The individual trips. Provide the right paging parameters to slice your result set. |
Kind: Object​
Implements: ITransportBehaviorAnnotation​
Property | Type | Description |
type | 'TurnBehaviorAnnotation' | |
start | String | ​ |
end | String | ​ |
maneuver | ​ | |
duration | Int | Duration is in milliseconds. |
path | ​ | |
magnitude | Float | The centripetal g-force you experience during turns, measured in (0.2*m)/s². Taking a turn at 60km/h will result in a higher magnitude compared to the same turn at 30 km/h |
Kind: ENUM
left_turn
right_turn
roundabout
lane_switch
Kind: Object​
Implements: IUser An anonymous SDK user that authenticates using the token strategy, can push data and can query only it's own data.
Property | Type | Description |
type | ​UserType​ | 'User' |
install_id | String | The unique identifier for active install id. |
external_id | String | The external id that was linked to this person. |
id | String | The unique identifier for this user. |
can_login | Boolean | ​ |
created_at | String | The time when this user was created, ISO8601. Example: 2015-05-28T14:37:14.839+00:00 |
sdk | ​UserSdkSettings​ | ​ |
application_id | String | The ID of the Application this user relates to. |
application | ​Application​ | The Application this user relates to. |
custom_event_history | ​CustomEvent​ | Custom Event History |
event_history | ​IEvent​ | An unordered list of events we have detected for this user. |
car_behavior | ​UserCarBehavior​ | The user car behavior aggregated over the last 9 weeks. |
aggregated_driving_scores | ​UserTimeAggregatedScores​ | ​ |
transport_heatmaps | ​TransportHeatmaps​ | The aggregated transport heatmaps calculated over time. |
metadata | ​JSON​ | All custom set metadata properties on this user. This is a JSON object with key->value pairs. |
device | ​DeviceInfo​ | The last known active tracking device metadata |
active_moments | ​IMoment​ | An unordered list of moments that are ongoing from the point of view of the platform. |
moment_history | ​IMoment​ | An unordered list of moments we have detected for this user. |
semantic_time | ​UserSemanticTime​ | The user's semantic time averaged over time. |
anomaly_history | ​IAnomaly​ | ​ |
segments | ​ISegment​ | An unordered list of segments that are detected for this user. |
location_clusters | ​LocationCluster​ | Locations this user has been stationary at and the features we have learned about those locations (significance, point of interest, ...) |
location | ​Waypoint​ | The last known location we have for this user. |
health | ​UserHealth​ | The historical health attributes. |
attributes | ​IUserAttribute​ | ​ |
predictions | ​IPrediction​ | Event/Moment predictions for this user |
prediction_tree | ​PredictionTree​ | 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. |
feedback_history | ​IFeedback​ | Feedback on this user |
Kind: Object​
Property | Type | Description |
type | String | 'UserAccountRole' |
user_id | String | ​ |
account_id | String | ​ |
role | String | ​ |
account | ​Account​ | ​ |
Kind: ENUM
TransportTimeAggregate
CommuteTimeAggregate
StationaryTimeAggregate
WorkingTimeAggregate
Kind: Object​
The historical car behavior profile for a user. Note that the user must have driven for at least 50 km during this period for the scores to be computed.
Property | Type | Description |
type | String | 'UserCarBehavior' |
scores | ​UserCarBehaviorScores​ | ​ |
features | ​UserCarBehaviorFeatures​ | ​ |
Kind: Object​
Property | Type | Description |
type | String | 'UserCarBehaviorFeatures' |
l7d | Recent features based on the transports we have analyzed in the last 7 days of data. | |
past | Historical features based on all transports we have available, excluding the last 7 days of data. |
Kind: Object​
Property | Type | Description |
type | String | 'UserCarBehaviorScores' |
l7d | ​ZoneCarBehaviorScores​ | Recent scores based on the transports we have analyzed in the last 7 days of data. Note that the user must have driven for at least 50 km during this period for the scores to be computed. |
past | ​ZoneCarBehaviorScores​ | Historical scores based on all transports we have analysed excluding the last 7 days of data. Note that the user must have driven for at least 50 km during this period for the scores to be computed. |
Kind: Object​
The historical health attributes.
Property | Type | Description |
type | String | 'UserHealth' |
scores | ​UserHealthScores​ | ​ |
Kind: Object​
This scoring system is used to track an individuals health.
Property | Type | Description |
type | String | 'UserHealthScores' |
activity | ​FloatAttribute​ | Score that measures a general overview of user health. It takes into account sport duration, walking/biking distance & walking/biking speed. A higher score means you are more active in regard to physical activity and exercise. |
mobility | ​FloatAttribute​ | Score that measures a general overview of user mobility, the higher the score, the more ability to pursue various activities in life. It combines the locations visited frequency, distance travelled and user action radius. It is independent of transport mode. |
work_social | ​FloatAttribute​ | Score that measures a general overview of user's social activities. It is calculated considering two components: the social score and work score. It takes into account how much time the user spends in locations, as well as how many locations the user visits. It is a measure of the number user social relationships together with their duration. It doesn't count user's home and work location, but remote work locations are considered. The higher the score, the more and the longer social interactions the user has. |
Kind: ENUM
developer
spectator
basic
The roles a user can have, both on accounts and apps.
Kind: Object​
User overrides that are used by the SDK configuration. This is not the SDK configuration model.
Property | Type | Description |
type | String | 'UserSdkSettings' |
flavor | ​SdkFlavor​ | If null, app-wide settings or defaults are active. |
killswitch_action | String | ​ |
debug_logging | String | If null, app-wide settings or defaults are active. |
Kind: Object​
Property | Type | Description |
type | String | 'UserSemanticTime' |
all_days | ​SemanticTimeAggregate​ | Historical semantic time averaged for all days over all data. |
Kind: Object​
Car transport scores by month, week, day.
Property | Type | Description |
all | ​CarBehaviorScores​ | Aggregation of all driving scores |
month | ​CarBehaviorScores​ | Aggregation of driving scores for a given month |
week | ​CarBehaviorScores​ | Aggregation of driving scores for a given week |
day | ​CarBehaviorScores​ | Aggregation of driving scores for a given day |
quarter | ​CarBehaviorScores​ | Aggregation of driving scores for a given quarter |
Kind: ENUM
User: An anonymous SDK user that authenticates using the token strategy, can push data and can query only it's own data.
ControlUser: A user that can authenticate using either password or token strategies, has an email address, might have access to dashboards, might have multiple roles, might manage multiple accounts and applications.
Kind: Object​
Access the user nodes
Kind: Object​
Property | Type | Description |
type | String | 'Waypoint' |
latitude | Float | Location fix latitude. |
longitude | Float | Location fix longitude. |
timestamp | String | ​ |
accuracy | Int | The estimated horizontal accuracy of this location, radial, in meters. |
speed | Float | The instantaneous speed of the device, measured in meters per second. A negative value indicates an invalid speed. |
altitude | Float | The altitude, measured in meters. Positive values indicate altitudes above sea level. Negative values indicate altitudes below sea level. |
Kind: Object​
Property | Type | Description |
summary | String | ​ |
icon | String | ​ |
precipIntensity | Float | ​ |
precipProbability | Float | ​ |
temperature | Float | ​ |
apparentTemperature | Float | ​ |
dewPoint | Float | ​ |
humidity | Float | ​ |
pressure | Float | ​ |
windSpeed | Float | ​ |
windGust | Float | ​ |
windBearing | Float | ​ |
cloudCover | Float | ​ |
uvIndex | Float | ​ |
visibility | Float | ​ |
ozone | Float | ​ |
Kind: Object​
Kind: Object​
Property | Type | Description |
type | String | 'WeightedLocation' |
latitude | Float | ​ |
longitude | Float | ​ |
weight | Float | ​ |
Kind: Object​
Implements: ITimeAggregateAttribute, IUserAttribute​
Property | Type | Description |
type | ​UserAttributeType​ | 'WorkingTimeAggregate' |
period | ​TimePeriod​ | ​ |
duration | Float | ​ |
whereabouts | ​WorkingTimeWhereabouts​ | ​ |
Kind: ENUM
all_locations: When at either regular work or remote locations visited during working time, excluding transports.
at_work: When working at work moment has been active, excluding nothing.
remote: When working remote moment has been active, including transports in between.
Kind: Object​
Car transport behavior scores by road type
Property | Type | Description |
type | String | 'ZoneCarBehaviorScores' |
all | ​CarBehaviorScores​ | Scores based on aggregated features across all zones. |
total | ​CarBehaviorScores​ | Scores based on the average of features per zone. |
motorway | ​CarBehaviorScores​ | Scores based on features in the motorway zones. |
city | ​CarBehaviorScores​ | Scores based on features in non-motorway city zones. |
non_city | ​CarBehaviorScores​ | Scores based on features in non-motorway non-city zones. |
