# via Offloads ## 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. {% hint style="warning" %} While offloads contain much of the core data, they do not include certain elements such as predictions, coaching data, or some fine-grained details. *Please consult with your Sentiance contact person to discuss the offloads before implementing.* {% endhint %} ## Accessing Offloads Access to offloads is managed by the [Sentiance Cloud API](https://docs.sentiance.com/sentiance-insights/accessing-sentiance-insights/via-cloud-api), with permissions authorized by the [API Key Scopes (OFFLOADS\_READ and OFFLOADS\_GENERATE\_URL)](https://docs.sentiance.com/important-topics/authentication-and-authorization#api-keys). To check available offloads, use an API Key with the `OFFLOADS_READ` scope. The query example is: ```graphql 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. ```json { "data": { "offloads": [ { "day": "2026-03-23", "files": [ { "format": "json.gz", "link": null, "name": "driving_insights", "size": 5523310 } ], "type": "OFFLOAD_TYPE_DRIVING_INSIGHTS" }, { "day": "2026-03-23", "files": [ { "format": "json.gz", "link": null, "name": "crash_insights", "size": 8943 } ], "type": "OFFLOAD_TYPE_CRASH_INSIGHTS" }, { "day": "2026-03-23", "files": [ { "format": "json.gz", "link": null, "name": "badges", "size": 5284 } ], "type": "OFFLOAD_TYPE_BADGES" }, { "day": "2026-03-23", "files": [ { "format": "json.gz", "link": null, "name": "challenges", "size": 8534 } ], "type": "OFFLOAD_TYPE_CHALLENGES" }, { "day": "2026-03-23", "files": [ { "format": "json.gz", "link": null, "name": "streaks", "size": 3862 } ], "type": "OFFLOAD_TYPE_STREAKS" } ] } } ``` 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`. ```graphql mutation { generate_offload_url(day: "2026-03-23", offload_type: OFFLOAD_TYPE_DRIVING_INSIGHTS) { offload { day type files { format link { expires_at url } name size } } } } ``` To generate a link to the offload files, you must use the [generate\_offload\_url](https://graphqldocs.sentiance.com/#mutation-generate_offload_url) mutation, giving the day of the offload and the type as input. This will respond with ```json { "data": { "generate_offload_url": { "offload": { "day": "2026-03-23", "files": [ { "format": "json.gz", "link": { "expires_at": "2026-04-07T11:32:29Z", "url": "https://sentiance-your-offloads.s3.eu-west-1.amazonaws.com/00000000000000000000000a/2026-03-23_0/driving_insights.json.gz?..." }, "name": "driving_insights", "size": 5523310 } ], "type": "OFFLOAD_TYPE_DRIVING_INSIGHTS" } } } } ``` 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](https://docs.sentiance.com/sentiance-insights/overview-of-sentiance-insights/driving-insights "mention"). {% file src="" %} **Mobility** The Mobility offload type is a subset of the Driving Insights offloads, without the driving events and driving scores data. {% file src="" %} #### **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 [vehicle-crash-detection](https://docs.sentiance.com/important-topics/vehicle-crash-detection "mention"). {% file src="" %} ### 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`. #### 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](https://docs.sentiance.com/sentiance-insights/engagement/challenges "mention"). #### 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](https://docs.sentiance.com/sentiance-insights/engagement/streaks "mention"). #### Groups These offloads contain information about all social groups your users create. For more information about the Social Groups feature, see [social-groups](https://docs.sentiance.com/sentiance-insights/engagement/social-groups "mention"). #### 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](https://docs.sentiance.com/sentiance-insights/engagement/social-groups "mention"). #### 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](https://docs.sentiance.com/sentiance-insights/engagement/communication-campaign "mention"). #### Daily Rewards Contains daily rewarded points for you users for the last 7 days. For more information about the Rewards feature, see [reward-system](https://docs.sentiance.com/sentiance-insights/engagement/reward-system "mention"). ### Appkit {% hint style="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. {% endhint %} #### Appkit All Users Contains all the users who got signup with Appkit related apps. #### 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](https://docs.sentiance.com/important-topics/sdk/api-reference/android/feedback "mention"), for iOS: [feedback](https://docs.sentiance.com/important-topics/sdk/api-reference/ios/feedback "mention")). #### 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 logevents](https://graphqldocs.sentiance.com/#mutation-submit_log_event). #### **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](https://docs.sentiance.com/sentiance-insights/firehose#off-the-grid-reasons). ## Deprecated types of Offloads {% hint style="warning" icon="clock" %} The following offload types are generated from results that are computed based on Cloud processing and are now deprecated. They are being phased out in a transition to full on-device processing for Driving Insights features. The file format of these offloads is columnar CSV, and do not support nested data fields to the same extend as the json file format, and thus require additional post-processing to join all the attributes for one individual transport. {% endhint %} ### **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 src="" %} #### **Driver Passenger** The driver passenger offload contains a list of transports, together with a corresponding prediction of driver or passenger (of the mobile user). {% file src="" %} #### **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. {% file src="" %} #### **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). {% file src="" %} #### **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 {% file src="" %} #### **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 {% file src="" %} #### **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 {% file src="" %} #### **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 {% file src="" %} #### **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 src="" %}