Search…
REST API Reference
All endpoints speak JSON. A Content-Type header with value application/json is expected to always be present.
The base url is https://api.sentiance.com/<version>/ for all REST endpoints, where the currently supported versions are v2 and v3. v1 has been fully deprecated. Note that not all APIs are common between v2 and v3 versions.
Note: The user deletion API is the only exception to the versioned endpoints rule. It stands on its own as DELETE /users/:user_id
For details on how to authenticate requests, have a look at the Authentication and Authorization page.
For other environments, please ask your sales representative or [email protected] for the custom endpoint linked to your environment.

V2 Endpoints

get
/v2/segment_definitions
Segment Definitions
get
/v2/moment_definitions
Moment Definitions
get
/v2/users/me
User's Own Profile
get
/v2/users/:user_id
Profile by User ID
get
/v2/users/:user_id/events?from=:from&to=:to
Timeline Events
get
/v2/users/:user_id/events/:start
Timeline Event by Start Time
get
/v2/users/:user_id/events/:start/trajectory
Trajectories by Start Time
get
/v2/users/:user_id/events/:start/behavior_scores
Behavior Scores by Start Time
get
/v2/users/:user_id/events/:start/behavior_annotations
Behavior Annotations by Start Time
get
/v2/users/:user_id/segments
User's Segments
get
/v2/users/:user_id/moments?from=:from&to=:to
Moment History
get
/v2/users/:user_id/active_moments
Active Moments
get
/v2/users/:user_id/location_clusters
Location Clusters
get
/v2/users/:user_id/location
Location
get
/v2/users/:user_id/car_behavior
Aggregated Behavior Scores
get
/v2/users/:user_id/anomalies?from=:from&to=:to
Anomaly History

V3 Endpoints

get
/v3/users/:user_id/events/:event_id
Timeline Event by EventId
get
/v3/users/:user_id/events/:event_id/trajectory
Trajectories by EventID
get
/v3/users/:user_id/events/:event_id/behavior_scores
Behavior Scores by EventID
get
/v3/users/:user_id/events/:event_id/behavior_annotations
Behavior Annotations by EventID
get
/v3/users/:user_id/aggregated_driving_scores
Time Aggregated Driving Scores

Unversioned Routes (no version prefix applied)

delete
/users/:user_id
Delete User
Last modified 1yr ago