E9 May 2022

This release notes document describes the details of version E9 in the following platforms:

Surfsight™ API E9 May 2022

This Release Notes document describes the following details for version E9 of the Surfsight™ API:

New features and enhancements

The Surfsight™ driver service is a set of new features (and enhancements to previous soft launches) that allow fleets with multiple drivers who often share the same vehicles, to associate trip data and events to the relevant driver. Integration with the Driver API endpoint enables:

  • Organization administrators to create and assign drivers to dashcams

  • Organization administrators to assign a unique driver code to each driver, thereby associating the driver to their trips and dashcam events

  • Companies to understand general driving patterns, or to focus on the challenges facing individual drivers

  • Managers to leverage data to coach or reward drivers

  • Reseller partners to integrate driver-related data into 3rd party applications

Note

In future software releases, Surfsight™ will continue to roll out new driver-related features and enhancements across our platforms.

The rest of this section provides the following information about this new driver service:

Terminology

Organization administrator - individuals performing API requests with administrative access to a specific organization(s)

Trip

A new trip begins when your vehicle dashcam registers a change of more than 100 meters, and ends when there is no GPS change for 5 or more minutes. Each trip that you see for your vehicle in the Surfsight™ Portal corresponds to the time stamp between these two points.

Event

Events are any of a number of risky incidents that can occur during a trip, such as acceleration, violent turns, or distracted driving.

Driver code - the unique 5-digit code used to assign a specific driver to a specific device

Dashcam driver PIN - the 4-digit PIN used by any driver to access recordings for a specific dashcam

How it works

The following diagram demonstrates the flow for the relevant API calls:

driverService_viewBuinessFlow

This flow is as follows:

  1. The organization administrator creates a new driver in their organization.

    The driver profile is generated, including the driver code.

  2. The organization administrator uses the driver code to assign the driver to a dashcam.

  3. When the driver starts driving, the trips and events of the associated dashcam are recorded and also associated with the driver.

  4. At the end of the trip, an organization administrator un-assigns the driver from the dashcam with the new API call.

    Note

    If the driver is not un-assigned, they will only be un-assigned and automatically replaced when a new driver is assigned to the same dashcam.

The API driver endpoint

Driver calls can be accessed via https://api-prod.surfsight.net/v2/drivers. With this endpoint, organization administrators can:

  • Create new drivers in an existing organization

  • Assign a driver to a dashcam prior to a trip, and retroactively (for a selected time period)

  • Un-assign a driver from a dashcam

  • Request the driver metadata in response to existing calls to retrieve trips or events

  • Retrieve the driving history of a specific dashcam, driver, or vehicle from a specified time range

  • Edit drivers for a specified organization

  • Delete drivers for a specified organization

Note

For exact details, parameters and instructions for these calls, refer to the Surfsight™ Developer Portal.

Fixed items

Issue ID

Problem

Resolution

SUR-4438

When users made calls to retrieve events from recently activated dashcams, they received data for several month-old events from before the dashcam had been activated.

Users are only receiving relevant events that apply to their dashcam from the time of its activation.

Was this article helpful?
0 out of 0 found this helpful