Surfsight concepts
The Surfsight API enables you to manage your fleets smoothly by leveraging a hierarchical structure for each account.
The following terms can help you understand the Surfsight API and functionality better:
| Concept | Definition |
|---|---|
| Device | Any piece of hardware that can be connected to a vehicle, such as the AI-12 dashcam. |
| Camera | Any device, or part thereof, that records video and takes snapshots as part of Surfsight events and trips, such as an in-cabin camera, a road-facing camera, or auxiliary cameras. |
| Auxiliary cameras | A camera that can be installed on different spots of a vehicle to enable tracking of other perspectives during trips. Each auxiliary camera is associated with a single device. |
| IMEI | The unique identifier of the device. This is used to specify which device you want to send data to or retrieve data about. The IMEI number can be found on the sticker on the device itself or on the back of the device box. |
| Organization | Organizations are the largest categorization for vehicles and their devices; each organization can contain any number of groups and devices. |
| Group | Groups are the second-largest categorization for vehicles and their devices; each group can contain any number of devices. Each group is part of an organization. |
| Events | Events are any of a number of risky incidents that can occur during a trip, such as acceleration, violent turns, or distracted driving. Events can be configured to upload as text, snapshots, or videos. Video events capture 5 seconds before and after the event occurs. The data tracked for each event includes the type of event, the date and time of the event, the location of the event, and the speed of the vehicle during the event. |
| Virtual event | Third-party events that telematics service providers (TSPs) generate from a device's recordings using the POST /devices/{imei}/virtual-event call. If TSP or other (non-Surfsight) devices create events without video or images, they can use the timestamps from those events in the API call to retreive video or snapshots of the third-party event. The virtual event call must contain a timestamp, in ISO 8601 format, of an available recording from the SD card of the device. |
| Recordings | Video of trips from all cameras associated with a device (the road-facing camera, the in-cabin camera, and any auxiliary cameras). The video is saved to the SD card and uploaded to the cloud. |
| Live streaming | Live video from all cameras associated with a device (the road-facing camera, the in-cabin camera, and any auxiliary cameras). Live video can be streamed directly from the device, from the cloud, or through the API. |