Insights
Search…
Introduction
A standard integration
FAQ
FAQ
SDK
Getting Started
Appendix
API Reference
Battery Optimization
How To
Troubleshooting
Changelog
Important topics
Authentication and Authorization
User linking
PlayStore Location Access Review
Privacy Report & Dashboard
Vehicle Crash Detection
Library
Events
Moments
Segments
Glossary
Backend
GraphQL
REST API Reference
Offloads
Data Reference
Data Reference A-G
Data Reference H-P
Data Reference Q-Z
Data Explorer
Data Explorer
Guide
Firehose
Verifying your integration
SDK Standard License
Journeys License
Journeys Application
Journeys Privacy Policy
Technical & Organizational Measures
Powered By GitBook
Data Reference Q-Z

Objects

SdkFlavor

Kind: ENUM
    full
    offline_driving
    realtime_marketing
    offline_segmentation
    triggered_trips

SegmentDefinition

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.

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
type
String
'SemanticTimeAggregate'
morning
​
lunch
​
afternoon
​
evening
​
night
​

SemanticTimeAggregateDaysEnum

Kind: ENUM
    all_days: All days are used in the calculation of the aggregate.

SemanticTimeAggregateValue

Kind: Object​
Property
Type
Description
type
String
'SemanticTimeAggregateValue'
semantic_time
​
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

Stationary

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
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
​
weather
Weather data associated with this event.

StationaryFeedback

Kind: Object​
Implements: IFeedback, IEventFeedback​
Property
Type
Description
type
'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
​
stationary
The Stationary this feedback refers to.

StationaryIntervalPrediction

Kind: Object​
Implements: IPrediction, IEventPrediction, IIntervalPrediction​
Property
Type
Description
type
'StationaryIntervalPrediction'
probability
Float
​
event_type
​EventType​
​
start_interval
​
location
​

StationaryLocation

Kind: Object​
Holds more information about a stationary location.
Property
Type
Description
type
String
'StationaryLocation'
significance
What this location means for the user, or the frequency it's being visited.
place
​
place_candidates
​

StationaryPrediction

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
'StationaryPrediction'
location_type
String
​
significance
String
​
place
​

StationaryTimeAggregate

Kind: Object​
Implements: ITimeAggregateAttribute, IUserAttribute​
Property
Type
Description
type
'StationaryTimeAggregate'
period
​
duration
Float
​
place_category
String
​
location_significance
​

TimePeriod

Kind: ENUM
    week

TimeWindowTransportHeatmaps

Kind: Object​
Property
Type
Description
type
String
'TimeWindowTransportHeatmaps'
car
​

TimeWindowUserCarBehaviorFeatures

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.

TrajectoryWaypoint

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.

Transport

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
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
The transport mode that was identified for this transport.
distance
Int
Distance is in meters.
occupant_role
​
waypoints
​Waypoint​
​
trajectory
​
behavior_scores
​
behavior_annotations
​
behavior_features
​
addresses
​
weather
Weather data associated with this event.

TransportAddresses

Kind: Object​
Property
Type
Description
origin
​Address​
​
destination
​Address​
​

TransportBehaviorAnnotationType

Kind: ENUM
    AccelerationBehaviorAnnotation
    BoundaryBehaviorAnnotation
    AnomalyBehaviorAnnotation
    TurnBehaviorAnnotation
    HandlingWithoutCallingAnnotation
    HandsfreeCallingAnnotation
    HandheldCallingAnnotation

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
type
'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
​
transport
​Transport​
The Transport this feedback refers to.

TransportHeatmaps

Kind: Object​
Historically aggregated transport heatmaps.
Property
Type
Description
type
String
'TransportHeatmaps'
l30d
Transport heatmaps that are calculated using the last .

TransportIntervalPrediction

Kind: Object​
Implements: IPrediction, IEventPrediction, IIntervalPrediction​
Property
Type
Description
type
'TransportIntervalPrediction'
probability
Float
​
event_type
​EventType​
​
start_interval
​
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.

TransportModeCategory

Kind: ENUM
    unknown
    healthy
    unhealthy

TransportModeHeatmaps

Kind: Object​
Property
Type
Description
type
String
'TransportModeHeatmaps'
passed
An aggregate heatmap based on the amounts of times you have passed the coordinates during transports.

TransportOccupantRole

Kind: ENUM
    driver
    passenger
    unknown

TransportPrediction

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
'TransportPrediction'
mode
String
​

TransportTimeAggregate

Kind: Object​
Implements: ITimeAggregateAttribute, IUserAttribute​
Property
Type
Description
type
'TransportTimeAggregate'
period
​
duration
Float
​
mode
​

TransportTrajectory

Kind: Object​
Property
Type
Description
type
String
'TransportTrajectory'
waypoints
​
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​

TreePredictionType

Kind: ENUM
    StationaryPrediction: Prediction of a Stationary event.
    TransportPrediction: Prediction of a Transport event.

Trip

Kind: Object​
Implements: IEvent​
Property
Type
Description
type
​EventType​
'Trip'
previous_event_id
String
​
next_event_id
String
​
user_id
String
​
start