API Version: 2021-02-16
We've released a new version of the API. This version updates the behavior of the Retrieve a unit of equipment API endpoint. Previously, this endpoint worked for any gateway within Samsara. This was not intended behavior. Now the endpoint only works for Equipment: assets connected to a Samsara Asset Gateway (AG) via APWR, CAT, or J1939 cables.
Daily Driver Activity API
The new Get all driver HOS daily logs API endpoint allows you to get a daily summary of activity for each driver. Check out the Daily Duty Status Summaries API Guide for more details and sample code.
Driver deactivatedAtTime
The Drivers APIs now support a deactivatedAtTime
field that indicates when a driver was deactivated.
External IDs in Routes and Route Stops
External IDs are now supported for both the top-level Route object as well as each route stop in the dispatch_jobs
array. See the Routing Guide for some example code.
Rate Limit Updates
We've updated the API rate limit policy. We will now enforce rate limits on a per-endpoint basis, in addition to the existing global rate limits. For example, the global rate limit is 200 requests per second, but the /fleet/hos/logs
endpoint is rate-limited at 30 requests per second. See the Rate Limits page for full details.
Driver ID Card Code in Drivers APIs
The Drivers APIs will now return a currentIdCardCode
string field that contains the NFC ID card code for each driver. This card code also shows up in the Vehicles Stats APIs when you query for types= nfcCardScans
.
Tag Name as Automatic External ID
Tag names can now function as automatic external IDs. For example, you can retrieve a tag by its name:
More vehicle diagnostics available via API
The following vehicle diagnostic types are now available via API. See the Telematics guide for full details.
Camera Media Endpoint
The GET /fleet/vehicles/cameras/media/history endpoint has been officially released. It allows you to get images from all dashcams in your fleet. Only images are currently available.
Driver ↔️ Vehicle Assignments
There are two new API endpoints that allow you to retrieve the driver(s) of each vehicle for a given time period and vice versa.: