> For the complete documentation index, see [llms.txt](https://docs.sentiance.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sentiance.com/getting-started/accessing-insights/offloads.md).

# 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, in json format. 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" %}
Offloads contain the core data types listed below, but not every field available through Sentiance's other channels (such as the Cloud API or Firehose).

*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](/getting-started/accessing-insights/cloud-api.md), with permissions authorized by\
[API Key Scopes](/sdk/appendix/request-authentication.md#api-keys):

* OFFLOADS\_READ
* OFFLOADS\_GENERATE\_URL

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**

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](/getting-started/features-catalog/driving-insights.md).

{% file src="/files/967f1t7sFO67vDPAsAa4" %}

### **Mobility**

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

{% file src="/files/sJGcZvu1t8lKuRajB6jz" %}

### **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 identifier
* transport identifier
* 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 insights feature, see [Crash Insights](/getting-started/features-catalog/crash-insights.md).

{% file src="/files/w3PTkPtXkXG6DVaplBc0" %}

### Smart Geofences

These offloads contain all the Smart Geofence events that have been detected.

* user identifier
* event time
* latitude, longitude (of the triggering location)
* geofence event type (`ENTRY` or `EXIT` )
* geofence identifier
* geofence group identifier

{% file src="/files/V64nOipbQr1kZv1FhiiN" %}

For more information about the Smart Geofence feature, see [Smart Geofences](/getting-started/features-catalog/smart-geofences.md).

### 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.

{% file src="/files/ESxSnBwo4KrGMsIxGmIT" %}

#### 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 src="/files/WslR2abvNpMG5wxR4wAD" %}

#### 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](/implementing-features/engagement/challenges.md).

{% file src="/files/BqrLFjKSw3M7D7PH8Nem" %}

#### 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](/implementing-features/engagement/streaks.md).

{% file src="/files/UxV6fXEmS4m5IjQAoe1J" %}

#### Groups

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

For more information about the Social Groups feature, see [Social Groups](/implementing-features/engagement/social-groups.md).

{% file src="/files/kRRv4z7jK2LZDAk71Nq2" %}

#### 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](/implementing-features/engagement/social-groups.md).

{% file src="/files/XvnToOeWz4imxggscJAV" %}

#### 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](/implementing-features/engagement/communication-campaign.md).

{% file src="/files/VTyCGsB15qo3QBu7C9Id" %}

#### Daily Rewards

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

For more information about the Rewards feature, see [Reward System](/implementing-features/engagement/reward-system.md).

### 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.

{% file src="/files/MbQ0O1MCRFB2gRJteLWJ" %}

#### Appkit Updated Users

Contains all the users who updated their user profiles.

{% file src="/files/RQ12LFQNDzwIMKG9ynQg" %}

#### Appkit Deleted Users

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

{% file src="/files/zPA70kNfzu2mQloFCAxP" %}

### 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

* Android: [FeedbackAPI](https://sentiance.github.io/android-sdk-api-docs/event-timeline/com.sentiance.sdk.feedback.api/-feedback-api/index.html)
* iOS: [SENTFeedback](https://sentiance.github.io/ios-sdk-api-docs/documentation/sentsdk/sentfeedback)

{% file src="/files/R7R35ttgkkuWkCj7nPoi" %}

#### 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).

{% file src="/files/oBn0WKp4kfA7aEvrp1jg" %}

#### **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.