Search…
Data Reference U-Z

Objects

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
Nullable
type
UserType
'User'
True
install_id
String
The unique identifier for active install id.
True
external_id
String
The external id that was linked to this person.
True
id
String
The unique identifier for this user.
True
can_login
Boolean
True
created_at
String
The time when this user was created, ISO8601. Example: 2015-05-28T14:37:14.839+00:00
True
sdk
True
application_id
String
The ID of the Application this user relates to.
True
application
The Application this user relates to.
True
custom_event_history
Custom Event History
True
event_history
IEvent
An unordered list of events we have detected for this user.
True
car_behavior
The user car behavior aggregated over the last 9 weeks.
True
aggregated_driving_scores
True
transport_heatmaps
The aggregated transport heatmaps calculated over time. Deprecation notice transport_heatmaps is deprecated. No longer used.
True
metadata
JSON
All custom set metadata properties on this user. This is a JSON object with key->value pairs.
True
device
The last known active tracking device metadata
True
active_moments
IMoment
An unordered list of moments that are ongoing from the point of view of the platform.
True
moment_history
IMoment
An unordered list of moments we have detected for this user.
True
semantic_time
The user's semantic time averaged over time.
True
anomaly_history
IAnomaly
Deprecation notice anomaly_history is deprecated. No longer relevant.
True

UserAccountRole

Kind: Object
Property
Type
Description
Nullable
type
String
'UserAccountRole'
True
user_id
String
True
account_id
String
True
role
String
True
account
Account
True

UserAttributeType

Kind: ENUM
  • TransportTimeAggregate
  • CommuteTimeAggregate
  • StationaryTimeAggregate
  • WorkingTimeAggregate

UserCarBehavior

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
Nullable
type
String
'UserCarBehavior'
True
scores
True
features
True

UserCarBehaviorFeatures

Kind: Object
Property
Type
Description
Nullable
type
String
'UserCarBehaviorFeatures'
True
l7d
Recent features based on the transports we have analyzed in the last 7 days of data.
True
past
Historical features based on all transports we have available, excluding the last 7 days of data.
True

UserCarBehaviorScores

Kind: Object
Property
Type
Description
Nullable
type
String
'UserCarBehaviorScores'
True
l7d
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. Deprecation notice l7d is deprecated. No longer supported.
True
past
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.
True

UserHealth

Kind: Object
The historical health attributes.
Property
Type
Description
Nullable
type
String
'UserHealth'
True
scores
True

UserHealthScores

Kind: Object
This scoring system is used to track an individuals health.
Property
Type
Description
Nullable
type
String
'UserHealthScores'
True
activity
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.
True
mobility
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.
True
work_social
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.
True

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
Nullable
type
String
'UserSdkSettings'
True
flavor
SdkFlavor
If null, app-wide settings or defaults are active.
True
killswitch_action
String
True
debug_logging
String
If null, app-wide settings or defaults are active.
True

UserSemanticTime

Kind: Object
Property
Type
Description
Nullable
type
String
'UserSemanticTime'
True
all_days
Historical semantic time averaged for all days over all data.
True

UserStepCount

Kind: Object
Access information on step count by different groupings. Note that only daily step counts are currently supported.
Property
Type
Description
Nullable
type
String
'UserStepCount'
True
daily
The daily step count activity data
True

UserStepCountDaily

Kind: Object
Daily information for step count
Property
Type
Description
Nullable
type
String
'UserStepCountDaily'
True
date
String
Date
True
count
Float
Count
True
hourly
Hourly step count information
True

UserStepCountHourly

Kind: Object
Hourly information for step count
Property
Type
Description
Nullable
type
String
'UserStepCountHourly'
True
hour
Float
Hour
True
count
Float
Count
True

UserTimeAggregatedScores

Kind: Object
Car transport scores by month, week, day.
Property
Type
Description
Nullable
all
Aggregation of all driving scores
True
month
Aggregation of driving scores for a given month. Enter date as YYYY-MM-DD. The DD part must always be 01. Month must always be 0 padded. So 4 should be 04. The default value is the start of the current month in UTC.
True
week
Aggregation of driving scores for a given week. Enter date as YYYY-MM-DD. The day must always correspond to the Monday of the week you're trying to access. So for the third week of April, it will be 2019-04-15. The default value is the start of the current week in UTC.
True
day
Aggregation of driving scores for a given day. Enter date as YYYY-MM-DD. It must correspond exactly to the date for which you want to access the aggregation. The default value is the current day in UTC.
True
quarter
Aggregation of driving scores for a given quarter. Enter date as YYYY-MM-DD. The DD part must always be 01. Month must always be 0 padded. So 4 should be 04. The default value is the start of the current quarter in UTC. Given date will be determine to derive the quarter, i.e 2021-09-27 belongs to quarter starting from 2021-07-01
True

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
Nullable
type
String
'UsersConnection'
True
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.
True
paging
Paging
True

Waypoint

Kind: Object
Property
Type
Description
Nullable
type
String
'Waypoint'
True
latitude
Float
Location fix latitude.
True
longitude
Float
Location fix longitude.
True
timestamp
String
True
accuracy
Int
The estimated horizontal accuracy of this location, radial, in meters.
True
speed
Float
The instantaneous speed of the device, measured in meters per second. A negative value indicates an invalid speed.
True
altitude
Float
The altitude, measured in meters. Positive values indicate altitudes above sea level. Negative values indicate altitudes below sea level.
True

Weather

Kind: Object
Property
Type
Description
Nullable
summary
String
True
icon
String
True
precipIntensity
Float
True
precipProbability
Float
True
temperature
Float
True
apparentTemperature
Float
True
dewPoint
Float
True
humidity
Float
True
pressure
Float
True
windSpeed
Float
True
windGust
Float
True
windBearing
Float
True
cloudCover
Float
True
uvIndex
Float
True
visibility
Float
True
ozone
Float
True

WeatherRange

Kind: Object
Property
Type
Description
Nullable
start
Weather
Weather data at the start of this event.
True
end
Weather
Weather data at the end of this event. Could be the same as the start if the event was short-lived.
True

WeightedLocation

Kind: Object
Property
Type
Description
Nullable
type
String
'WeightedLocation'
True
latitude
Float
True
longitude
Float
True
weight
Float
True

WorkingTimeAggregate

Kind: Object
Property
Type
Description
Nullable
type
'WorkingTimeAggregate'
True
period
True
duration
Float
True
whereabouts
True

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
Nullable
type
String
'ZoneCarBehaviorScores'
True
all
Scores based on aggregated features across all zones.
True
total
Scores based on the average of features per zone.
True
motorway
Scores based on features in the motorway zones.
True
city
Scores based on features in non-motorway city zones.
True
non_city
Scores based on features in non-motorway non-city zones.
True