> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withterminal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Surfsight

> This document provides an overview of Terminal's integration with Surfsight. It shows which data models are currently available in production and which ones are in active development.

## Provider Details

* **Provider Code**: `surfsight`
* **Available History**: Depends on plan: Between 30 days and 90 days
* **Vehicle Location Sample Rate**: 5 seconds
* **[Crash Reports](/terminal-platform/crash-reports)**: *Supported*

## Supported Models

### Entities

<AccordionGroup>
  <Accordion title="Device" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    The percentage of connections that have data populated for each field, averaged across the connections using this provider.

    | Field             | Coverage                                               |
    | ----------------- | ------------------------------------------------------ |
    | `description`     | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `id`              | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `lastConnectedAt` | <Badge color="green" icon="circle-check">93.2%</Badge> |
    | `provider`        | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `serialNumber`    | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `sourceId`        | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `type`            | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `vehicle`         | <Badge color="red" icon="circle-xmark">0%</Badge>      |
  </Accordion>

  <Accordion title="Driver" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    The percentage of connections that have data populated for each field, averaged across the connections using this provider.

    | Field            | Coverage                                              |
    | ---------------- | ----------------------------------------------------- |
    | `email`          | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `firstName`      | <Badge color="green" icon="circle-check">100%</Badge> |
    | `groups`         | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `id`             | <Badge color="green" icon="circle-check">100%</Badge> |
    | `lastName`       | <Badge color="green" icon="circle-check">100%</Badge> |
    | `license.number` | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `license.state`  | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `middleName`     | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `phone`          | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `provider`       | <Badge color="green" icon="circle-check">100%</Badge> |
    | `sourceId`       | <Badge color="green" icon="circle-check">100%</Badge> |
    | `status`         | <Badge color="green" icon="circle-check">100%</Badge> |
    | `username`       | <Badge color="red" icon="circle-xmark">0%</Badge>     |
  </Accordion>

  <Accordion title="Group" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    The percentage of connections that have data populated for each field, averaged across the connections using this provider.

    | Field         | Coverage                                              |
    | ------------- | ----------------------------------------------------- |
    | `description` | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `id`          | <Badge color="green" icon="circle-check">100%</Badge> |
    | `name`        | <Badge color="green" icon="circle-check">100%</Badge> |
    | `parent`      | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `provider`    | <Badge color="green" icon="circle-check">100%</Badge> |
    | `sourceId`    | <Badge color="green" icon="circle-check">100%</Badge> |
  </Accordion>

  <Accordion title="Trailer" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#d32f2f" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM175 175c9.4-9.4 24.6-9.4 33.9 0l47 47 47-47c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-47 47 47 47c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-47-47-47 47c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l47-47-47-47c-9.4-9.4-9.4-24.6 0-33.9z"/></svg>}>
    Surfsight does not support this model.
  </Accordion>

  <Accordion title="Vehicle" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    The percentage of connections that have data populated for each field, averaged across the connections using this provider.

    | Field                 | Coverage                                               |
    | --------------------- | ------------------------------------------------------ |
    | `devices`             | <Badge color="green" icon="circle-check">75.6%</Badge> |
    | `fuelTankCapacity`    | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `fuelType`            | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `groups`              | <Badge color="red" icon="circle-xmark">20%</Badge>     |
    | `id`                  | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `licensePlate.number` | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `licensePlate.state`  | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `make`                | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `model`               | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `name`                | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `provider`            | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `sourceId`            | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `status`              | <Badge color="green" icon="circle-check">100%</Badge>  |
    | `vin`                 | <Badge color="red" icon="circle-xmark">0%</Badge>      |
    | `year`                | <Badge color="red" icon="circle-xmark">0%</Badge>      |
  </Accordion>
</AccordionGroup>

### Real-Time Data

<AccordionGroup>
  <Accordion title="HOS Available Time" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#d32f2f" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM175 175c9.4-9.4 24.6-9.4 33.9 0l47 47 47-47c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-47 47 47 47c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-47-47-47 47c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l47-47-47-47c-9.4-9.4-9.4-24.6 0-33.9z"/></svg>}>
    Surfsight does not support this model.
  </Accordion>

  <Accordion title="Latest Trailer Location" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#d32f2f" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM175 175c9.4-9.4 24.6-9.4 33.9 0l47 47 47-47c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-47 47 47 47c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-47-47-47 47c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l47-47-47-47c-9.4-9.4-9.4-24.6 0-33.9z"/></svg>}>
    Surfsight does not support this model.
  </Accordion>

  <Accordion title="Latest Vehicle Location" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    Supported by Surfsight. Attribute coverage is not yet tracked for this model.
  </Accordion>
</AccordionGroup>

### Historical Data

<AccordionGroup>
  <Accordion title="Fault Code Event" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#e6a800" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>}>
    Terminal does not support this model for Surfsight yet.
  </Accordion>

  <Accordion title="HOS Daily Log" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#d32f2f" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM175 175c9.4-9.4 24.6-9.4 33.9 0l47 47 47-47c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-47 47 47 47c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-47-47-47 47c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l47-47-47-47c-9.4-9.4-9.4-24.6 0-33.9z"/></svg>}>
    Surfsight does not support this model.
  </Accordion>

  <Accordion title="HOS Log" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#d32f2f" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM175 175c9.4-9.4 24.6-9.4 33.9 0l47 47 47-47c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-47 47 47 47c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-47-47-47 47c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l47-47-47-47c-9.4-9.4-9.4-24.6 0-33.9z"/></svg>}>
    Surfsight does not support this model.
  </Accordion>

  <Accordion title="IFTA Vehicle Month" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#e6a800" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>}>
    Terminal does not support this model for Surfsight yet.
  </Accordion>

  <Accordion title="Safety Event" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    The percentage of connections that have data populated for each field, averaged across the connections using this provider.

    | Field                               | Coverage                                                |
    | ----------------------------------- | ------------------------------------------------------- |
    | `cameraMedia.frontFacing.available` | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `cameraMedia.frontFacing.sourceId`  | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `cameraMedia.rearFacing.available`  | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `cameraMedia.rearFacing.sourceId`   | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `driver`                            | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `endedAt`                           | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `endLocation.latitude`              | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `endLocation.longitude`             | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `id`                                | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `provider`                          | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `sourceId`                          | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `startedAt`                         | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `startLocation.latitude`            | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `startLocation.longitude`           | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `stats.averageSpeed`                | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `stats.gForceForwardBackward`       | <Badge color="orange" icon="circle-minus">40.9%</Badge> |
    | `stats.gForceSideToSide`            | <Badge color="orange" icon="circle-minus">40.9%</Badge> |
    | `stats.heading`                     | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `stats.maximumSpeed`                | <Badge color="orange" icon="circle-minus">51.7%</Badge> |
    | `stats.roadSpeedLimit`              | <Badge color="red" icon="circle-xmark">0%</Badge>       |
    | `type`                              | <Badge color="green" icon="circle-check">100%</Badge>   |
    | `vehicle`                           | <Badge color="green" icon="circle-check">100%</Badge>   |

    The record types this provider supports.

    <AccordionGroup>
      <Accordion title="Available" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
        `camera_obstruction`, `cell_phone`, `crash`, `distracted`, `drowsiness`, `eating_and_drinking`, `harsh_acceleration`, `harsh_brake`, `harsh_turn`, `seat_belt_violation`, `smoking`, `speeding`, `tailgating`, `unsafe_lane_change`
      </Accordion>

      <Accordion title="Unavailable" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#d32f2f" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM175 175c9.4-9.4 24.6-9.4 33.9 0l47 47 47-47c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-47 47 47 47c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-47-47-47 47c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l47-47-47-47c-9.4-9.4-9.4-24.6 0-33.9z"/></svg>}>
        `near_crash`, `red_light_violation`, `rolling_stop`, `stop_sign_violation`, `unsafe_parking`
      </Accordion>
    </AccordionGroup>
  </Accordion>

  <Accordion title="Trip" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#e6a800" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>}>
    Terminal does not support this model for Surfsight yet.
  </Accordion>

  <Accordion title="Vehicle Location" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#45a049" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z"/></svg>}>
    The percentage of connections that have data populated for each field, averaged across the connections using this provider.

    | Field               | Coverage                                              |
    | ------------------- | ----------------------------------------------------- |
    | `address.formatted` | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `driver`            | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `heading`           | <Badge color="red" icon="circle-xmark">0%</Badge>     |
    | `id`                | <Badge color="green" icon="circle-check">100%</Badge> |
    | `locatedAt`         | <Badge color="green" icon="circle-check">100%</Badge> |
    | `location`          | <Badge color="green" icon="circle-check">100%</Badge> |
    | `provider`          | <Badge color="green" icon="circle-check">100%</Badge> |
    | `speed`             | <Badge color="green" icon="circle-check">100%</Badge> |
    | `vehicle`           | <Badge color="green" icon="circle-check">100%</Badge> |
  </Accordion>

  <Accordion title="Vehicle Stat Log" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#e6a800" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>}>
    Terminal does not support this model for Surfsight yet.
  </Accordion>

  <Accordion title="Vehicle Utilization" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#e6a800" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>}>
    Terminal does not support this model for Surfsight yet.
  </Accordion>
</AccordionGroup>

### Other

<AccordionGroup>
  <Accordion title="Camera Media" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="16" width="16"><path fill="#e6a800" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>}>
    Terminal does not support this model for Surfsight yet.
  </Accordion>
</AccordionGroup>

## References

<CardGroup cols={2}>
  <Card title="Surfsight Login" href="https://app.surfsight.net/" arrow="true" horizontal />

  <Card title="Surfsight Developer Documentation" href="https://developer.surfsight.net/openapi/surfsight/overview/" arrow="true" horizontal />
</CardGroup>
