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

​SemanticTimeAggregateValue​

​

lunch

​SemanticTimeAggregateValue​

​

afternoon

​SemanticTimeAggregateValue​

​

evening

​SemanticTimeAggregateValue​

​

night

​SemanticTimeAggregateValue​

​

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

​SemanticTime​

​

days

​SemanticTimeAggregateDaysEnum​

​

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'

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.

StationaryFeedback

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.

StationaryIntervalPrediction

Kind: Object​

Implements: IPrediction, IEventPrediction, IIntervalPrediction​

Property

Type

Description

type

​PredictionType​

'StationaryIntervalPrediction'

probability

Float

​

event_type

​EventType​

​

start_interval

​PredictionInterval​

​

location

​StationaryLocation​

​

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​

​

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

​TreePredictionType​

'StationaryPrediction'

location_type

String

​

significance

String

​

place

​LocationPlaceCandidate​

​

StationaryTimeAggregate

Kind: Object​

Implements: ITimeAggregateAttribute, IUserAttribute​

Property

Type

Description

type

​UserAttributeType​

'StationaryTimeAggregate'

period

​TimePeriod​

​

duration

Float

​

place_category

String

​

location_significance

​LocationSignificance​

​

StreamDefinition

Kind: Object​

Stream definition that can be activated/subscribed to with the Sentiance Firehose

Property

Type

Description

type

String

'StreamDefinition'

id

String

​

name

String

​

projection

String

The GQL query that will be provided on every notification.

created_at

String

​

subscriptions

​SubscriptionsConnection​

​

StreamDefinitionConnectionType

Kind: ENUM

  • websockets

  • sns

    Stream definition connection type.

Subscription

Kind: Object​

Subscription that can be activated to receive data from the Sentiance Firehose.

Property

Type

Description

type

String

'Subscription'

id

String

​

token

String

​

active

Boolean

​

connection_type

​StreamDefinitionConnectionType​

​

user_ids

​String​

​

created_at

String

​

SubscriptionsConnection

Kind: Object​

Access the stream subscriptions

Property

Type

Description

type

String

'SubscriptionsConnection'

slice

​Subscription​

The individual subscriptions. Provide the right paging parameters to slice your result set.

TimePeriod

Kind: ENUM

  • week

TimeWindowTransportHeatmaps

Kind: Object​

Property

Type

Description

type

String

'TimeWindowTransportHeatmaps'

car

​TransportModeHeatmaps​

​

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

Float

The average speed between this waypoint and the next waypoint, in km/h.

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.

distance

Float

The distance in meter between the current waypoint and the next waypoint.

speed_limit

Float

Speed limit measured at this point in the trajectory. As is provided by our mapping data partners.

Transport

Kind: Object​

Implements: IEvent​

Property

Type

Description

type

​EventType​

'Transport'

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.

mode

​TransportMode​

The transport mode that was identified for this transport.

distance

Int

​

occupant_role

​TransportOccupantRole​

​

waypoints

​Waypoint​

​

trajectory

​TransportTrajectory​

​

behavior_scores

​TransportBehaviorScores​

​

behavior_annotations

​ITransportBehaviorAnnotation​

​

behavior_features

​TransportBehaviorFeatures​

​

weather

​WeatherRange​

Weather data associated with this event.

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

​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.

TransportHeatmaps

Kind: Object​

Historically aggregated transport heatmaps.

Property

Type

Description

type

String

'TransportHeatmaps'

l30d

​TimeWindowTransportHeatmaps​

Transport heatmaps that are calculated using the last .

TransportIntervalPrediction

Kind: Object​

Implements: IPrediction, IEventPrediction, IIntervalPrediction​

Property

Type

Description

type

​PredictionType​

'TransportIntervalPrediction'

probability

Float

​

event_type

​EventType​

​

start_interval

​PredictionInterval​

​

mode

​TransportMode​

​

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.

  • 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

​WeightedLocation​

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

​TreePredictionType​

'TransportPrediction'

mode

String

​

TransportTimeAggregate

Kind: Object​

Implements: ITimeAggregateAttribute, IUserAttribute​

Property

Type

Description

type

​UserAttributeType​

'TransportTimeAggregate'

period

​TimePeriod​

​

duration

Float

​

mode

​TransportMode​

​

TransportTrajectory

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​

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'

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​

​

TripConnection

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.

TurnBehaviorAnnotation

Kind: Object​

Implements: ITransportBehaviorAnnotation​

Property

Type

Description

type

​TransportBehaviorAnnotationType​

'TurnBehaviorAnnotation'

start

String

​

end

String

​

maneuver

​TurnBehaviorAnnotationManeuver​

​

duration

Int

​

path

​BehaviorAnnotationPathWaypoint​

​

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

TurnBehaviorAnnotationManeuver

Kind: ENUM

  • left_turn

  • right_turn

  • roundabout

  • lane_switch

User

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

UserAccountRole

Kind: Object​

Property

Type

Description

type

String

'UserAccountRole'

user_id

String

​

account_id

String

​

role

String

​

account

​Account​

​

UserAttributeType

Kind: ENUM

  • TransportTimeAggregate

  • CommuteTimeAggregate

  • StationaryTimeAggregate

  • WorkingTimeAggregate

UserCarBehavior

Kind: Object​

The historical car behavior profile for a user.

Property

Type

Description

type

String

'UserCarBehavior'

scores

​UserCarBehaviorScores​

​

features

​UserCarBehaviorFeatures​

​

UserCarBehaviorFeatures

Kind: Object​

Property

Type

Description

type

String

'UserCarBehaviorFeatures'

l7d

​TimeWindowUserCarBehaviorFeatures​

Recent features based on the transports we have analyzed in the last 7 days of data.

past

​TimeWindowUserCarBehaviorFeatures​

Historical features based on all transports we have available, excluding the last 7 days of data.

UserCarBehaviorScores

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.

past

​ZoneCarBehaviorScores​

Historical scores based on all transports we have analysed excluding the last 7 days of data.

UserHealth

Kind: Object​

The historical health attributes.

Property

Type

Description

type

String

'UserHealth'

scores

​UserHealthScores​

​

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.

UserRole

Kind: ENUM

  • developer

  • spectator

  • basic

    The roles a user can have, both on accounts and apps.

UserSdkSettings

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.

UserSemanticTime

Kind: Object​

Property

Type

Description

type

String

'UserSemanticTime'

all_days

​SemanticTimeAggregate​

Historical semantic time averaged for all days over all data.

UserTimeAggregatedScores

Kind: Object​

Car transport scores by month, week, day.

Property

Type

Description

month

​CarBehaviorScores​

​

week

​CarBehaviorScores​

​

day

​CarBehaviorScores​

​

UserType

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.

UsersConnection

Kind: Object​

Access the user nodes

Property

Type

Description

type

String

'UsersConnection'

slice

​IUser​

The individual user nodes. Provide the right paging parameters to slice your response data. By default a slice holds 100 users, which you can increase to 1000.

paging

​Paging​

​

Waypoint

Kind: Object​

Property

Type

Description

type

String

'Waypoint'

latitude

Float

​

longitude

Float

​

timestamp

String

​

accuracy

Int

The estimated horizontal accuracy of this location, radial, in meters.

Weather

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

​

WeatherRange

Kind: Object​

Property

Type

Description

start

​Weather​

Weather data at the start of this event.

end

​Weather​

Weather data at the end of this event. Could be the same as the start if the event was short-lived.

WeightedLocation

Kind: Object​

Property

Type

Description

type

String

'WeightedLocation'

latitude

Float

​

longitude

Float

​

weight

Float

​

WorkingTimeAggregate

Kind: Object​

Implements: ITimeAggregateAttribute, IUserAttribute​

Property

Type

Description

type

​UserAttributeType​

'WorkingTimeAggregate'

period

​TimePeriod​

​

duration

Float

​

whereabouts

​WorkingTimeWhereabouts​

​

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.

ZoneCarBehaviorScores

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.