Data Reference v4

Objects

  • RootQuery

  • RootMutation

  • AbandonUserEngagementChallenge

  • AcceleratingEvent

  • AcceptUserEngagementChallenge

  • AdditionalMobilityDetails

  • BrakingEvent

  • CallEvent

  • CreateUserEngagementGroup

  • Diagnostics

  • Engagement

  • JoinUserEngagementGroup

  • LeaveUserEngagementGroup

  • LocationInformation

  • MapMatchedWaypoint

  • MountedEvent

  • OffTheGrid

  • PathElement

  • PhoneEventSpeed

  • PhoneHandlingEvent

  • PrimarySafetyScores

  • RawDataPoints

  • RawWaypoint

  • ScreenEvent

  • SecondarySafetyScores

  • SpeedingEvent

  • SubmitLogEvent

  • Transport

  • TransportDrivingEvents

  • TransportFeedback

  • TransportScores

  • TransportScoresSafety

  • TransportTrajectory

  • TransportWeatherData

  • TurningEvent

  • User

  • UserEngagement

  • UserEngagementBadge

  • UserEngagementBadges

  • UserEngagementChallenge

  • UserEngagementChallenges

  • UserEngagementChallengesSlice

  • UserEngagementCommunication

  • UserEngagementCommunicationResponse_ContextEntry

  • UserEngagementCommunications

  • UserEngagementCommunicationsSlice

  • UserEngagementGroup

  • UserEngagementGroupFeed

  • UserEngagementGroupFeedMessage

  • UserEngagementGroupLeaderboard

  • UserEngagementGroupLeaderboardMember

  • UserEngagementGroupMember

  • UserEngagementGroupMembers

  • UserEngagementGroups

  • UserEngagementLibrary

  • UserEngagementLibraryItem

  • UserEngagementLibraryKnowledgeBites

  • UserEngagementLibrarySmartTips

  • UserEngagementScores

  • UserEngagementStreaks

  • UserEngagementStreaksCount

  • UserEngagementTransport

  • UserEngagementTransportScores

  • UserEngagementTransportTrajectory

  • UserEngagementTransportTrajectoryLocation

  • UserEngagementTransports

  • UserEngagementTransportsMeta

  • UserScores

  • UserScoresDriving

  • UserScoresDrivingSafety

  • WeatherData

RootQuery

Kind: Object

Property
Type
Description
Nullable

engagement

Engagement

True

transport

Transport

True

user

User

True

RootMutation

Kind: Object

Property
Type
Description
Nullable

abandon_challenge

AbandonUserEngagementChallenge

True

accept_challenge

AcceptUserEngagementChallenge

True

create_group

CreateUserEngagementGroup

True

join_group

JoinUserEngagementGroup

True

leave_group

LeaveUserEngagementGroup

True

submit_log_event

SubmitLogEvent

True

submit_transport_feedback

TransportFeedback

True

AbandonUserEngagementChallenge

Kind: Object

Property
Type
Description
Nullable

status

Boolean

True

AcceleratingEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the acceleration event (e.g. acceleration).

True

duration

Float

Duration of the acceleration event in seconds.

True

end_at

String

The end time of the acceleration event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

magnitude

Float

Max magnitude of the acceleration, measured in m/s².

True

path

PathElement

Path (waypoints) of the acceleration event while it lasted.

True

start_at

String

The start time of the acceleration event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'AcceleratingEvent'

True

AcceptUserEngagementChallenge

Kind: Object

Property
Type
Description
Nullable

status

Boolean

True

AdditionalMobilityDetails

Kind: Object

Property
Type
Description
Nullable

raw_data_points

RawDataPoints

True

BrakingEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the braking event.

True

duration

Float

Duration of the braking event in seconds.

True

end_at

String

The end time of the braking event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

magnitude

Float

Max magnitude of the braking, measured in m/s².

True

path

PathElement

Path (waypoints) of the braking event while it lasted.

True

start_at

String

The start time of the braking event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'BrakingEvent'

True

CallEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the call event.

True

duration

Float

Duration of the call event in seconds.

True

end_at

String

The end time of the call event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

speed

PhoneEventSpeed

The speed during the call event.

True

start_at

String

The start time of the call event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'CallEvent'

True

CreateUserEngagementGroup

Kind: Object

Property
Type
Description
Nullable

group

UserEngagementGroup

True

status

Boolean

True

Diagnostics

Kind: Object

Property
Type
Description
Nullable

off_the_grids

OffTheGrid

True

Engagement

Kind: Object

Property
Type
Description
Nullable

group

UserEngagementGroup

True

JoinUserEngagementGroup

Kind: Object

Property
Type
Description
Nullable

status

Boolean

True

LeaveUserEngagementGroup

Kind: Object

Property
Type
Description
Nullable

status

Boolean

True

LocationInformation

Kind: Object

Property
Type
Description
Nullable

city

String

The city to which the location belongs.

True

country

String

The country to which the location belongs.

True

district

String

The district to which the location belongs.

True

region

String

The region to which the location belongs.

True

street

String

The street to which the location belongs.

True

MapMatchedWaypoint

Kind: Object

Property
Type
Description
Nullable

distance

Float

The distance in meters between the current waypoint and the previous waypoint.

True

latitude

Float

Waypoint latitude in degrees with accuracy of 5 decimals.

True

longitude

Float

Waypoint longitude in degrees with accuracy of 5 decimals.

True

road_type

String

The type of road in which the waypoint was mapped (e.g. motorway, pedestrian, highway, etc.).

True

speed

Float

The speed in km/h at the moment the waypoint was mapped.

True

speed_limit

Float

The speed limit in km/h of the road where the waypoint was mapped.

True

timestamp

String

Waypoint timestamp in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

MountedEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the mounted phone event.

True

duration

Float

Duration of the mounted phone event in seconds.

True

end_at

String

The end time of the mounted phone event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

start_at

String

The start time of the mounted phone event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'MountedEvent'

True

OffTheGrid

Kind: Object

Property
Type
Description
Nullable

end_at

String

The end time of the off-the-grid in ISO 8601 format (e.g. 2022-06-27T11:26:48.351+01:00).

True

off_the_grid_id

String

Unique ID of the off-the-grid event.

True

reason

OffTheGrid_OffTheGridReasonEnum

The reason why the off-the-grid started (e.g. OFF_THE_GRID_LOCATION_PERMISSION).

True

start_at

String

The start time of the off-the-grid in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

OffTheGrid_OffTheGridReasonEnum

Kind: ENUM

  • OFF_THE_GRID_BGACCESS_PERMISSION

  • OFF_THE_GRID_AIRPLANE_MODE

  • OFF_THE_GRID_LOCATION_MODE_DEVICE_ONLY

  • OFF_THE_GRID_LOCATION_ACCESS_ALWAYS

  • OFF_THE_GRID_KILLSWITCH

  • OFF_THE_GRID_BG_EXECUTION_RESTRICTED

  • OFF_THE_GRID_LOCATION_ACCURACY_REDUCED

  • OFF_THE_GRID_NETWORK_PERMISSION

  • OFF_THE_GRID_LOCATION_MODE_OFF

  • OFF_THE_GRID_SDK_NOT_RUNNING

  • OFF_THE_GRID_LOCATION_PERMISSION

  • OFF_THE_GRID_MOTION_ACTIVITY_PERMISSION

  • OFF_THE_GRID_DISKUSAGE_PERMISSION

  • OFF_THE_GRID_LOCATION_MODE_BATTERY_SAVING

  • OFF_THE_GRID_PLAY_SERVICES

  • OFF_THE_GRID_GEOFENCE_TRANSITION_TIMEOUT

  • OFF_THE_GRID_DISK_QUOTA_EXCEEDED

  • OFF_THE_GRID_BG_DETECTIONS_NOT_ALLOWED

  • OFF_THE_GRID_EXTERNAL_EVENT

  • OFF_THE_GRID_OTHER

  • OFF_THE_GRID_NO_LOCATION_FIXES

  • OFF_THE_GRID_OUTAGE

PathElement

Kind: Object

Property
Type
Description
Nullable

latitude

Float

Location-fix latitude in degrees with accuracy of 5 decimals.

True

longitude

Float

Location-fix longitude in degrees with accuracy of 5 decimals.

True

PhoneEventSpeed

Kind: Object

Property
Type
Description
Nullable

max

Float

True

min

Float

True

PhoneHandlingEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the phone handling event.

True

duration

Float

Duration of the phone handling event in seconds.

True

end_at

String

The end time of the phone handling event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

path

PathElement

Path (waypoints) of the phone handling event while it lasted.

True

speed

PhoneEventSpeed

The speed during the phone handling event.

True

start_at

String

The start time of the phone handling event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'PhoneHandlingEvent'

True

PrimarySafetyScores

Kind: Object

Property
Type
Description
Nullable

attention

Float

A combined score of handheld calling, hands-free calling and handling without calling. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

legal

Float

The legal driving score measures how well you adhere to speed limits. The higher your score, the more you respect the speed limits. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

overall

Float

A combined score of the legal, smooth, and attention scores. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

smooth

Float

The smooth driving score measures how smooth you drive. High accelerations, heavy braking and heavy turning result in a lower score. The use of coasting results in a higher score. Scores are normalized with respect to a wide population. The higher your score, the smoother you drive. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

RawDataPoints

Kind: Object

Property
Type
Description
Nullable

distance

Float

The total distance travelled in meters. Based on the Haversine distance

True

raw_waypoints

RawWaypoint

List of raw waypoints.

True

top_speed

Float

Top speed reached in the transport in km/h.

True

RawWaypoint

Kind: Object

Property
Type
Description
Nullable

accuracy

Int

Waypoint accuracy in meters.

True

latitude

Float

Waypoint latitude in degrees with accuracy of 5 decimals.

True

longitude

Float

Waypoint longitude in degrees with accuracy of 5 decimals.

True

speed

Float

The speed in km/h

True

timestamp

String

Waypoint timestamp in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

ScreenEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the phone screen event.

True

duration

Float

Duration of the phone screen event in seconds.

True

end_at

String

The end time of the phone screen event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

speed

PhoneEventSpeed

The speed during the phone screen event.

True

start_at

String

The start time of the phone screen event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'ScreenEvent'

True

SecondarySafetyScores

Kind: Object

Property
Type
Description
Nullable

anticipation

Float

The anticipative driving score measures how well you anticipate turns. Hard accelerations before or hard braking during a turn result in a lower score. The use of coasting results in a higher score. The higher your score, the more anticipative you drive. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

focus

Float

The proportion of time (percentage) the user is focused while driving, being focused means: not using the phone, which is detected through phone handling. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

harsh_acceleration

Float

Measures how often you accelerate hard. Every hard acceleration will be penalised by subtracting a percentage of your score. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

harsh_braking

Float

Measures how often you need to brake hard. Every hard brake will be penalised by subtracting a percentage of your score. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

harsh_events

Float

This is a combination of hard_accel and hard_brake score. The hard brakes and accelerations are also normalized by the total number of events. When we do not have sufficient data this value will be -1.

True

harsh_turning

Float

Measures how often you turn hard. Every hard turn will be penalised by subtracting a percentage of your score. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

mounted

Float

The proportion of time (percentage) the phone is mounted while driving. Range: 0..1. If we did not obtain sufficient data, the value will be -1.

True

SpeedingEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the speeding event.

True

duration

Float

Duration of the speeding event in seconds.

True

end_at

String

The end time of the speeding event in ISO 8601 format (e.g. 2022-06-26T11:26:48.350+01:00).

True

path

PathElement

Path (waypoints) of the speeding event while it lasted.

True

speed_limits

Int

List of speed limits in km/h corresponding to the waypoints in the path.

True

speeds

Float

List of speeds in km/h corresponding to the waypoints in the path.

True

start_at

String

The start time of the speeding event in ISO 8601 format (e.g. 2022-06-26T11:26:48.350+01:00).

True

type

String

'SpeedingEvent'

True

SubmitLogEvent

Kind: Object

Property
Type
Description
Nullable

message

String

True

status

Boolean

True

SubmitLogEventRequest_EventParamsEntryInput

Kind: INPUT_OBJECT

Transport

Kind: Object

Property
Type
Description
Nullable

additional_mobility_details

AdditionalMobilityDetails

Additional mobility insights of the transport.

True

driving_events

TransportDrivingEvents

The driving events detected in the transport (CAR only).

True

duration

Int

Total duration of the transport in seconds.

True

end_at

String

End time of the transport in ISO 8601 format (e.g. 2022-06-26T15:21:21.351+01:00).

True

metadata

String

JSON array of of key-value pairs with metadata sent by the client.

True

mode

String

The transport mode. Possible values are: [biking, bus, car, ferry, idle, insufficient_data, running, train, tram, unsupported_mode, walking].

True

occupant_role

String

The occupant role information of the transport.

True

scores

TransportScores

The driving scores assigned to the transport.

True

start_at

String

Start time of the transport in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

top_speed

Float

Top speed reached in the transport in km/h.

True

trajectory

TransportTrajectory

The trajectory details of the transport.

True

transport_id

String

The unique ID of the transport.

True

weather_data

TransportWeatherData

The weather data at the origin and destination of the transport

True

TransportDrivingEvents

Kind: Object

Property
Type
Description
Nullable

accelerating

AcceleratingEvent

List of accelerating events.

True

braking

BrakingEvent

List of braking events.

True

calls

CallEvent

List of call events.

True

mounted

MountedEvent

List of mounted events.

True

phone_handling

PhoneHandlingEvent

List of phone-handling events.

True

screens

ScreenEvent

List of screen events.

True

speeding

SpeedingEvent

List of speeding events.

True

turning

TurningEvent

List of turning events.

True

TransportDrivingEventsRequest_DrivingEventsFilterEnum

Kind: ENUM

  • ALL

  • SIGNIFICANT

TransportFeedback

Kind: Object

Property
Type
Description
Nullable

status

Boolean

True

TransportFeedbackRequest_ContextEntryInput

Kind: INPUT_OBJECT

TransportScores

Kind: Object

Property
Type
Description
Nullable

safety

TransportScoresSafety

True

TransportScoresSafety

Kind: Object

Property
Type
Description
Nullable

primary

PrimarySafetyScores

Primary driving safety scores assigned to the transport.

True

secondary

SecondarySafetyScores

Secondary driving safety scores assigned to the transport.

True

TransportTrajectory

Kind: Object

Property
Type
Description
Nullable

distance

Float

The total distance travelled in meters.

True

end_location

LocationInformation

Information about the ending location of the trajectory.

True

map_matched_waypoints

MapMatchedWaypoint

The map-matched waypoints of the trajectory.

True

polyline

String

The encoded path using Google's Encoded Polyline Algorithm format.

True

start_location

LocationInformation

Information about the starting location of the trajectory.

True

top_speed

Float

Top speed reached in the transport in km/h.

True

TransportWeatherData

Kind: Object

Property
Type
Description
Nullable

weather_at_destination

WeatherData

The weather data at the destination of the transport

True

weather_at_origin

WeatherData

The weather data at the origin of the transport

True

TurningEvent

Kind: Object

Property
Type
Description
Nullable

category

String

The main category of the turning event (e.g. turning).

True

duration

Float

Duration of the turning event in seconds.

True

end_at

String

The end time of the turning event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

magnitude

Float

Max magnitude of the turning, measured in m/s².

True

path

PathElement

Path (waypoints) of the turning event while it lasted.

True

start_at

String

The start time of the turning event in ISO 8601 format (e.g. 2022-06-26T11:26:48.351+01:00).

True

type

String

'TurningEvent'

True

User

Kind: Object

Property
Type
Description
Nullable

app_id

String

App ID to which the user belongs.

True

created_at

String

Date and time of user creation in the Sentiance platform in ISO 8601 format (e.g. 2022-06-26T11:26:48.000+00:00).

True

diagnostics

Diagnostics

Diagnostics API for user-related events and information.

True

engagement

UserEngagement

Engagement information e.g driver coaching score, streaks, challenges, etc.

True

external_id

String

ID of the user given by the client application (if present).

True

scores

UserScores

Time-aggregated driving scores of the user.

True

transports

Transport

List of transports belonging to the user.

True

user_id

String

Sentiance ID of the user.

True

UserEngagement

Kind: Object

Property
Type
Description
Nullable

badges

UserEngagementBadges

Engagement badges

True

challenges

UserEngagementChallenges

Engagement challenges

True

communications

UserEngagementCommunications

Communications of a user by ID

True

groups

UserEngagementGroups

Engagement groups

True

library

UserEngagementLibrary

Engagement Content Library

True

scores

UserEngagementScores

Engagement scores

True

streaks

UserEngagementStreaks

Engagement streaks

True

transport

UserEngagementTransport

Transport of a user by ID

True

transports

UserEngagementTransports

Transports of the user

True

UserEngagementBadge

Kind: Object

Property
Type
Description
Nullable

category

String

True

completed_at

String

True

description

String

True

id

String

True

image_url

String

True

level

Int

True

name

String

True

progress

Int

True

reward_text

String

True

started_at

String

True

status

String

True

updated_at

String

True

UserEngagementBadges

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementBadge

True

UserEngagementChallenge

Kind: Object

Property
Type
Description
Nullable

accepted_at

String

True

can_receive_feedback

Boolean

True

category

String

True

challenge_id

String

True

count

Int

True

description

String

True

difficulty

String

True

ended_at

String

True

id

String

True

image_url

String

True

new

String

True

ordering

Int

True

progress

Int

True

status

String

True

subcategory

String

True

updated_at

String

True

UserEngagementChallenges

Kind: Object

Property
Type
Description
Nullable

active

UserEngagementChallengesSlice

Active Challenges of the user

True

available

UserEngagementChallengesSlice

Available Challenges of the user

True

completed

UserEngagementChallengesSlice

Completed Challenges of the user

True

UserEngagementChallengesSlice

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementChallenge

True

UserEngagementCommunication

Kind: Object

Property
Type
Description
Nullable

category

String

True

communication_id

String

True

context

UserEngagementCommunicationResponse_ContextEntry

True

evaluation_id

String

True

expires_at

String

True

generated_at

String

True

message

String

True

priority

Int

True

status

String

True

title

String

True

type

String

'UserEngagementCommunication'

True

updated_at

String

True

UserEngagementCommunicationResponse_ContextEntry

Kind: Object

Property
Type
Description
Nullable

key

String

False

value

String

False

UserEngagementCommunications

Kind: Object

Property
Type
Description
Nullable

closed

UserEngagementCommunicationsSlice

Closed Communications of the user

True

expired

UserEngagementCommunicationsSlice

Expired Communications of the user

True

new

UserEngagementCommunicationsSlice

New Communications of the user

True

UserEngagementCommunicationsRequest_CategoryEnum

Kind: ENUM

  • PROFILE

  • ALL

  • CHALLENGES

  • BADGES

  • STREAKS

  • SCORES

  • LEADERBOARD

  • TRIPS

UserEngagementCommunicationsRequest_TypeEnum

Kind: ENUM

  • IN_APP_MESSAGE

  • REACTIVE_MESSAGE

UserEngagementCommunicationsSlice

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementCommunication

True

UserEngagementGroup

Kind: Object

Property
Type
Description
Nullable

created_at

String

True

feed

UserEngagementGroupFeed

True

group_id

String

True

leaderboard

UserEngagementGroupLeaderboard

True

members

UserEngagementGroupMembers

True

name

String

True

reg_code

String

True

user_id

String

True

UserEngagementGroupFeed

Kind: Object

Property
Type
Description
Nullable

group_id

String

True

slice

UserEngagementGroupFeedMessage

True

UserEngagementGroupFeedMessage

Kind: Object

Property
Type
Description
Nullable

generated_at

String

True

message

String

True

params

String

True

UserEngagementGroupLeaderboard

Kind: Object

Property
Type
Description
Nullable

group_id

String

True

slice

UserEngagementGroupLeaderboardMember

True

UserEngagementGroupLeaderboardMember

Kind: Object

Property
Type
Description
Nullable

rank

Int

True

ranking_attr

String

True

ranking_score

Float

True

user_id

String

True

UserEngagementGroupMember

Kind: Object

Property
Type
Description
Nullable

joined_at

String

True

scores

UserEngagementScores

User's Engagement scores

True

user_id

String

True

UserEngagementGroupMembers

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementGroupMember

True

UserEngagementGroups

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementGroup

Groups of a user

True

user_id

String

True

UserEngagementLibrary

Kind: Object

Property
Type
Description
Nullable

knowledge_bites

UserEngagementLibraryKnowledgeBites

True

smart_tips

UserEngagementLibrarySmartTips

True

UserEngagementLibraryItem

Kind: Object

Property
Type
Description
Nullable

category

String

True

content

String

True

content_extra

String

True

created_at

String

True

item_id

String

True

subcategory

String

True

title

String

True

UserEngagementLibraryKnowledgeBites

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementLibraryItem

True

UserEngagementLibrarySmartTips

Kind: Object

Property
Type
Description
Nullable

slice

UserEngagementLibraryItem

True

UserEngagementScores

Kind: Object

Property
Type
Description
Nullable

driving_focused

Float

True

driving_no_speeding

Float

True

driving_overall

Float

True

driving_smooth

Float

True

riding_call_while_moving

Float

True

riding_harsh

Float

True

riding_legal

Float

True

riding_overall

Float

True

UserEngagementStreaks

Kind: Object

Property
Type
Description
Nullable

best

UserEngagementStreaksCount

Best streaks of the user

True

current

UserEngagementStreaksCount

Current streaks

True

user_id

String

True

UserEngagementStreaksCount

Kind: Object

Property
Type
Description
Nullable

driving_focused

Int

True

driving_no_speeding

Int

True

driving_safe

Int

True

driving_smooth

Int

True

UserEngagementTransport

Kind: Object

Property
Type
Description
Nullable

can_receive_feedback

Boolean

True

created_at

String

True

duration

Float

True

end_at

String

True

mode

String

True

scores

UserEngagementTransportScores

True

start_at

String

True

trajectory

UserEngagementTransportTrajectory

True

transport_id

String

True

UserEngagementTransportScores

Kind: Object

Property
Type
Description
Nullable

driving_focused

Float

True

driving_focused_adaptive

Float

True

driving_no_speeding

Float

True

driving_no_speeding_adaptive

Float

True

driving_overall

Float

True

driving_overall_adaptive

Float

True

driving_smooth

Float

True

driving_smooth_adaptive

Float

True

riding_call_while_moving

Float

True

riding_call_while_moving_adaptive

Float

True

riding_harsh

Float

True

riding_harsh_adaptive

Float

True

riding_legal

Float

True

riding_legal_adaptive

Float

True

riding_overall

Float

True

riding_overall_adaptive

Float

True

UserEngagementTransportTrajectory

Kind: Object

Property
Type
Description
Nullable

distance

Float

True

end_location

UserEngagementTransportTrajectoryLocation

True

polyline

String

True

start_location

UserEngagementTransportTrajectoryLocation

True

UserEngagementTransportTrajectoryLocation

Kind: Object

Property
Type
Description
Nullable

latitude

Float

True

longitude

Float

True

street

String

True

UserEngagementTransports

Kind: Object

Property
Type
Description
Nullable

meta

UserEngagementTransportsMeta

True

slice

UserEngagementTransport

True

UserEngagementTransportsMeta

Kind: Object

Property
Type
Description
Nullable

next_token

String

True

UserScores

Kind: Object

Property
Type
Description
Nullable

driving

UserScoresDriving

True

UserScoresDriving

Kind: Object

Property
Type
Description
Nullable

safety

UserScoresDrivingSafety

True

UserScoresDrivingSafety

Kind: Object

Property
Type
Description
Nullable

primary

PrimarySafetyScores

Primary safety scores belonging to the user.

True

secondary

SecondarySafetyScores

Secondary safety scores belonging to the user.

True

WeatherData

Kind: Object

Property
Type
Description
Nullable

apparent_temperature

Float

The apparent temperature is a measure for the human thermal comfort. On the basis of the air temperature, the apparent temperature is computed considering effects of relative humidity, wind speed and solar radiation.

True

cloud_cover

Float

Cloud cover as a fraction between 0-1.

True

dew_point

Float

Dew point in degrees celcius

True

humidity

Float

Relative humidity as a fraction between 0-1.

True

icon

String

URL of the icon representing the weather

True

ozone

Float

deprecated; no longer available

True

precipitation_intensity

Float

Precipitation accumulated over the past hour in millimeter

True

precipitation_probability

Float

Probability of precipitation

True

pressure

Float

Pressure in millibars

True

summary

String

Textual description of the weather

True

sunrise

String

time of sunrise

True

sunset

String

time of sunset

True

temperature

Float

Instantaneous temperature at 2m above ground in degrees Celsius

True

uv_index

Float

UV Index

True

visibility

Float

Visibility in km

True

wind_bearing

Float

Wind direction in degrees due north

True

wind_gust

Float

Wind gust in m/s

True

wind_speed

Float

Wind speed in m/s

True

Last updated