Documentation Index
Fetch the complete documentation index at: https://samsara-showcase.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Recipe: Custom Duty Status Report
View on developers.samsara.com
Recipe: HOS Exemption Report
View on developers.samsara.com
Managing Driver Info and ELD Rulesets
The Drivers API endpoints allow you to create, retrieve, update, and deactivate drivers. These endpoints allow you to manage general driver data such as Driver App credentials, name and contact info, and license information. Additionally, these endpoints also allow you to manage ELD settings:| ELD Setting Type | Field Name(s) | API Capabilities |
|---|---|---|
| ELD exemptions | eldAdverseWeatherExemptionEnabled, eldBigDayExemptionEnabled, eldExempt, eldExemptReason | Read/Write |
| ELD day start hour | eldDayStartHour | Read/Write |
| Personal conveyance | eldPcEnabled | Read/Write |
| Yard moves | eldYmEnabled | Read/Write |
| ELD rulesets for US State, cycle, restarts, and break | eldSettings | Read-only. Must be set in the cloud dashboard. Attempts to write to this field via the API will be ignored. |
Real-time Duty Status
The Get HOS clocks endpoint allows you to retrieve the current duty status of all your drivers. Each call to this endpoint returns current values for:- Current duty status
- Time until break
- Driving time remaining
- Shift time remaining
- Cycle time remaining
Daily Duty Status Summaries
The Get all driver HOS daily logs endpoint allows you to retrieve a summarized report of daily activity for each driver. The report will include:- Time spent in each duty status per day
- Distance driven per day, broken up into personal conveyance and yard moves if enabled
- Vehicles assignments for the day
- Trailer assignments for the day
- Shipping doc assignments for the day
- Log certification information