via Offloads

Sentiance provides data offloads with Sentiance Insights to the clients on a daily basis.

What are Offloads

The Sentiance platform offers various methods to access and analyze your end-users' data, one of which is through offloads—our implementation of a file-based system, typically in json format (or CSV format for older product offerings). Offloads generally contain data for all your users over a specific timeframe, by default a 24-hour tumbling window. Detailed field descriptions can be found below.

circle-exclamation

Accessing Offloads

Access to offloads is managed by the Sentiance Cloud APIarrow-up-right, with permissions authorized by the API Key Scopes (OFFLOADS_READ and OFFLOADS_GENERATE_URL)arrow-up-right.

To check available offloads, use an API Key with the OFFLOADS_READ scope. The query example is:

query {
  offloads(from: "2026-03-23", to: "2026-03-23") {
    day
    type
    files {
      format
      link {
        expires_at
        url
      }
      name
      size
    }
  }
}

from and to are always days in the format YYYY-MM-DD. The response looks like the following.

Offloads of several types are available (based on which Sentiance product offering you are using). Each day will contain one offload of each type and each offload item may have one or more associated files to download.

The files list their format, name, size and a link to download that file.

In the response above the link field is null since no links have been generated for these files yet. Link generation is done with an API Key with the scope OFFLOADS_GENERATE_URL.

To generate a link to the offload files, you must use the generate_offload_urlarrow-up-right mutation, giving the day of the offload and the type as input. This will respond with

Links expire after a set time and must be regenerated if needed. Offloads for the previous day are fully available, while current-day offloads may be incomplete.

Types of Offloads

The following offloads are available based on your product selection on the Sentiance platform. The availability of some granular data fields also depends on your product selection.

Driving Insights

Driving Insights

The Driving Insights offload type is a bundle of all the insights related to transports that the Sentiance SDK has detected and processed on the users devices. Each json line contains results for one detected transport for a user, e.g. start time, end time, transport mode, waypoints, driving events, driving scores, ... For a detailed explanation of the attributes, see the Driving Insights.

Mobility

The Mobility offload type is a subset of the Driving Insights offloads, without the driving events and driving scores data.

file-download
70KB

Crash Insights

This offload file contains a list of transports during which a crash event was detected. The following context around the crash is available for each such transport:

  • user_id

  • transport_id

  • timestamp

  • latitude

  • longitude

  • speed limit

  • gps speed (from the latest gps signal before the crash)

  • speed at impact (from all sensor data combined by the crash model)

  • delta v

  • max magnitude

  • crash severity

  • confidence

For more information about the crash detection feature, see Crash Detection.

Engagement

Custom Scores

These offloads contain the trip-by-trip scores and their corresponding user scores based on your integration with the Engagement platform. Can be similar to Driving Insights scores or different if you have a custom integration.

Badges

These offloads contain events related to your user’s progress towards achieving Badges. A badge state can change to be ACTIVE, IN_PROGRESS or COMPLETED.

file-download
594B

Challenges

These offloads contain events related to your user’s progress towards completing a challenge. A challenge state can change to: ACCEPTED, COMPLETED, IN_PROGRESS, FAILED, ABANDONED.

For more information about the Challenges feature, see Challenges.

file-download
20B

Streaks

These offloads contain events related to your user’s progress towards continuing and maintaining streaks. A streak state can change to: NEW, CONTINUE, BREAK.

For more information about the Streaks feature, see Streaks.

file-download
2KB

Groups

These offloads contain information about all social groups your users create.

For more information about the Social Groups feature, see Social Groups.

file-download
42KB

Group Members

These offloads contain information about users who are part of groups and their role in the groups. A user can have one of these roles: ADMIN, MEMBER, PENDING.

For more information about the Social Groups feature, see Social Groups.

Communications

These offloads contain information about each communication message that was generated for your users and whether or not a user interacted with it. A communication message can have one of these states: NEW, MANUALLY_CLOSED, AUTOMATICALLY_CLOSED.

For more information about the Communications feature, see Communication Campaign.

Daily Rewards

Contains daily rewarded points for your users for the last 7 days.

For more information about the Rewards feature, see Reward System.

Appkit

circle-info

This offload types in this section are only available if you are using Sentiance Insights App or any custom Appkit Apps built by Sentiance.

Appkit All Users

Contains all the users who got signup with Appkit related apps.

file-download
347B

Appkit Updated Users

Contains all the users who updated their user profiles.

Appkit Deleted Users

Contains all the users who deleted their Appkit based app accounts.

Other

Feedback

These offloads contain information about feedback provided by your users about our transport mode and occupant role predictions. This requires an integration of the mobile app with the Sentiance Feedback API (for Android: Feedback, for iOS: Feedback).

file-download
345B

App Events

These offloads contain events generated by your user by using the mobile app. This requires an integration of the mobile app with the Sentiance backend API to submit logeventsarrow-up-right.

file-download
153KB

Off-the-grids

Off-the-grids correspond to segments of time when the user was offline and not sending data from their mobile device to our platform. For an explanation of the possible of the grid reasons see here.

Deprecated types of Offloads

clock

Driving Insights

Transports

Transports represent the period of time a user moved from one venue to another. The transports offloads contain a list of transports and their corresponding predicted transport mode (e.g. car, train, bus, etc.), duration and top speed.

file-download
620B

Driver Passenger

The driver passenger offload contains a list of transports, together with a corresponding prediction of driver or passenger (of the mobile user).

Driving Events (all)

This offload file contains a list of transports, together with their corresponding lists of all driving events. The following driving events are available:

  • accelerating events

  • phone handling events

  • turning events

  • mounted events

  • braking events

  • speeding events

  • call events

  • screen events

All driving events for transports are included in this offload.

Driving Events (significant)

This offload file contains a list of transports, together with their corresponding lists of significant driving events. The following driving events are available:

  • accelerating events

  • phone handling events

  • turning events

  • mounted events

  • braking events

  • speeding events

  • call events

  • screen events

Significant events are a subset of all events, and only driving events that fall under certain thresholds are included (e.g. accelerations that have a high magnitude or calls that have a long duration).

Primary Safety Scores (transports)

These offloads contain a list of transports and their corresponding primary safety scores.

The primary safety scores available are:

  • legal

  • smooth

  • attention

  • overall

Secondary Safety Scores (transports)

These offloads contain a list of transports and their corresponding secondary safety scores.

The secondary safety scores available are:

  • focus

  • harsh acceleration

  • harsh braking

  • harsh turning

  • anticipation

  • mounted

Primary Safety Scores (users)

These offloads contain a list of users and their corresponding primary safety scores, based on their overall driving.

The primary safety scores available are:

  • legal

  • smooth

  • attention

  • overall

Secondary Safety Scores (users)

These offloads contain a list of users and their corresponding secondary safety scores, based on their overall driving.

The secondary safety scores available are:

  • focus

  • harsh acceleration

  • harsh braking

  • harsh turning

  • anticipation

  • mounted

Trajectories

Trajectories are information specific about the route that a transports followed. These offloads contain information such as the total distance traveled, the mapped waypoints of the transport, and the start and end addresses.

file-download
849B

Last updated