Data Reference H-L
Property | Type | Description | Nullable |
---|---|---|---|
type | 'HandheldCallingAnnotation' | True | |
start | String | | True |
end | String | | True |
duration | Int | Duration is in milliseconds. | True |
path | | True |
Property | Type | Description | Nullable |
---|---|---|---|
type | 'HandlingWithoutCallingAnnotation' | True | |
start | String | | True |
end | String | | True |
duration | Int | Duration is in milliseconds. | True |
path | | True |
Property | Type | Description | Nullable |
---|---|---|---|
type | 'HandsfreeCallingAnnotation' | True | |
start | String | | True |
end | String | | True |
duration | Int | Duration is in milliseconds. | True |
path | | True |
Kind: INTERFACE
Implemented by: AggregatedDistanceAnomaly, AggregatedDurationAnomaly, DayCountAnomaly, OccurrenceCountAnomaly An anomaly that we have detected for a user over a period of time.
Property | Type | Description | Nullable |
---|---|---|---|
period | Aggregation period over which the data is calculated. | True | |
day_part | Optional additional aggregation over which the data is calculated. | True |
Kind: INTERFACE
Implemented by: DistanceAnomaly, AggregatedDistanceAnomaly, DurationAnomaly, AggregatedDurationAnomaly, DayCountAnomaly, OccurrenceCountAnomaly An anomaly that we have detected for a user.
Property | Type | Description | Nullable |
---|---|---|---|
type | 'IAnomaly' | True | |
start | String | | True |
end | String | | True |
analysis_type | Deprecation notice
analysis_type is deprecated.
After significantly improving our platform's real-timeliness, we now don't need the analysis of a trip to go through multiple phases. This means you no longer need to filter our Firehose or API output by AnalysisType. Previously, trips had three analysis types based on processing latency. They were, namely, 'processed,' 'indepth,' and 'preliminary.' Based on your use cases, you may have filtered out certain types. As we will deprecate this field on Dec 10, 2021, you will need to change your backend if you use the AnalysisType field. | True | |
anomaly | | True | |
sigma | Float | The observed standard deviation from expected behavior for this anomaly. If the standard deviation is high, the anomaly confidence will be low. | True |
probability | Float | The larger the probability, the more anomaly. Value is between 0.0 and 1.0. | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
start | String | Predicted start time of the event. | True |
end | String | Predicted end time of the event. | True |
probability | Float | The probability of this prediction occurring. | True |
type | 'IBranchEvent' | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
observed_days | Float | Observed amount of days. | True |
expected_days | Float | Expected amount of days. | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
observed_distance | Float | Observed distance in meter. | True |
expected_distance | Float | Expected distance in meter. | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
observed_duration | Float | Observed duration in seconds. | True |
expected_duration | Float | Expected duration in seconds. | True |
Kind: INTERFACE
Implemented by: Trip, Stationary, Transport An occurrence of an event that we have detected for a user. This interface is implemented by the Stationary and Transport models.
Property | Type | Description | Nullable |
---|---|---|---|
type | 'IEvent' | True | |
event_id | String | | False |
previous_event_id | String | | True |
next_event_id | String | | True |
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 | True |
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 | True |
start_ts | | True | |
end_ts | | True | |
analysis_type | How well this event is analyzed by the platform, this value will update over time.
Possible values:
preliminary, indepth, processed.
Deprecation notice
analysis_type is deprecated.
After significantly improving our platform's real-timeliness, we now don't need the analysis of a trip to go through multiple phases. This means you no longer need to filter our Firehose or API output by AnalysisType. Previously, trips had three analysis types based on processing latency. They were, namely, 'processed,' 'indepth,' and 'preliminary.' Based on your use cases, you may have filtered out certain types. As we will deprecate this field on Dec 10, 2021, you will need to change your backend if you use the AnalysisType field. | True | |
weather | Weather data associated with this event. | True |
Kind: INTERFACE
Implemented by: StationaryFeedback, TransportFeedback An occurrence of event feedback submitted by a user.
Property | Type | Description | Nullable |
---|---|---|---|
event_feedback | | True |
Kind: INTERFACE
Implemented by: StationaryIntervalPrediction, TransportIntervalPrediction An occurrence of an event prediction that we have detected for a user.
Property | Type | Description | Nullable |
---|---|---|---|
event_type | | True |
Kind: INTERFACE
Implemented by: StationaryFeedback, TransportFeedback, CrashFeedback, MomentFeedback An occurrence of feedback submitted by a user.
Property | Type | Description | Nullable |
---|---|---|---|
type | 'IFeedback' | True | |
start | String | Start time the feedback relates to, sourced by the event, moment or user-provided. | False |
end | String | End time the feedback relates to, sourced by the event, moment or user-provided. | True |
created | String | Time when this feedback entry was created. | True |
projection_time | String | Time to provide when the feedback data was read from the API. ISO8601. Optional. | True |
Kind: INTERFACE
Implemented by: StationaryIntervalPrediction, TransportIntervalPrediction A prediction that has a start interval.
Property | Type | Description | Nullable |
---|---|---|---|
start_interval | | True |
Kind: INTERFACE
Implemented by: GenericMoment, CityMoment, CountryMoment An occurrence of a MomentDefinition that we have detected for a user.
Property | Type | Description | Nullable |
---|---|---|---|
type | 'IMoment' | True | |
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 | True |
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 | True |
start_ts | | True | |
end_ts | | True | |
analysis_type | How well this moment is analyzed by the platform, this value will update over time.
Possible values:
preliminary, indepth, processed.
Deprecation notice
analysis_type is deprecated.
After significantly improving our platform's real-timeliness, we now don't need the analysis of a trip to go through multiple phases. This means you no longer need to filter our Firehose or API output by AnalysisType. Previously, trips had three analysis types based on processing latency. They were, namely, 'processed,' 'indepth,' and 'preliminary.' Based on your use cases, you may have filtered out certain types. As we will deprecate this field on Dec 10, 2021, you will need to change your backend if you use the AnalysisType field. | True | |
moment_definition_id | String | The ID of the MomentDefinition this moment relates to. | True |
moment_definition | The MomentDefinition this moment relates to. | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
moment_definition_id | String | | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
moment_feedback | | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
observed_occurrences | Float | Observed amount of occurrences. | True |
expected_occurrences | Float | Expected amount of occurrences. | True |
Kind: INTERFACE
Implemented by: StationaryIntervalPrediction, TransportIntervalPrediction An occurance of a prediction that we have detected for a user.
Property | Type | Description | Nullable |
---|---|---|---|
type | 'IPrediction' | True | |
probability | Float | | True |
Kind: INTERFACE
Implemented by: GenericSegment An occurrence of a SegmentDefinition that we have detected for this user.
Property | Type | Description | Nullable |
---|---|---|---|
type | 'ISegment' | True | |
segment_definition_id | String | The ID of the SegmentDefinition this segment relates to. | True |
segment_definition | The SegmentDefinition this segment relates to. | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
place_category | String | | True |
location_significance | | True |
Kind: INTERFACE
Implemented by: CommuteTimeAggregate, StationaryTimeAggregate, TransportTimeAggregate, WorkingTimeAggregate An attribute that aggregates by TimePeriod.
Property | Type | Description | Nullable |
---|---|---|---|
period | | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
transport_mode | | True | |
transport_mode_category | | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
type | 'ITransportBehaviorAnnotation' | True | |
start | String | | True |
end | String | | True |
Kind: INTERFACE
Property | Type | Description | Nullable |
---|---|---|---|
type | 'IUser' | 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 | 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 | 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 | An unordered list of moments that are ongoing from the point of view of the platform. | True | |
moment_history | 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 | Deprecation notice
anomaly_history is deprecated.
No longer relevant. | True | |
segments | An unordered list of segments that are detected for this user. | True | |
location_clusters | Locations this user has been stationary at and the features we have learned about those locations (significance, point of interest, ...) | True | |
location | The last known location we have for this user. | True | |
health | The historical health attributes.
Deprecation notice
health is deprecated.
No longer supported | True | |
attributes | Deprecation notice
attributes is deprecated.
No longer supported. | True | |
predictions | Event/Moment predictions for this user
Deprecation notice
predictions is deprecated.
Please use prediction_tree . | True | |
prediction_tree | 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. | True | |
feedback | Feedback on this user
Deprecation notice
feedback is deprecated.
Replaced by feedback_history | True | |
feedback_history | Feedback on this user | True | |
step_count | Step count details of the given user on the given date range. This feature is currently in Beta, for additional information contact [email protected] | True |
Kind: INTERFACE