Samsara Fleets API
The Fleets API from Samsara — 7 operation(s) for fleets.
Samsara Fleets API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Fleets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 7 operations across 7 paths, and defines 150 schemas. It is described by OpenAPI 3.0.1, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
7 operations
7 paths
150 schemas
5 GET2 PATCH
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Fleets API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 5 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.
Fleets 7
GET
/beta/fleet/drivers/efficiency
[beta] List Driver Efficiency
PATCH
/beta/fleet/equipment/{id}
[beta] Update an Equipment
GET
/beta/fleet/hos/drivers/eld-events
[beta] Get Driver HOS ELD Events
GET
/beta/fleet/trailers/stats
[beta] Get Trailer Stats
GET
/beta/fleet/trailers/stats/feed
[beta] Get Trailer Stats Feed
GET
/beta/fleet/trailers/stats/history
[beta] Get Trailer Stats History
PATCH
/beta/fleet/vehicles/{id}/immobilizer
[beta] Update Engine Immobilizer State of a Vehicle.
Schemas 150
The contract defines 150 schemas that model the data the API accepts and returns. The most detailed are TrailerStatsSnapshotObjectResponseBody (25 properties), TrailerStatsObjectResponseBody (25 properties), TrailerStatDecorationResponseBody (23 properties), DriverEfficiency (14 properties). Each schema is shown below with its type and property counts.
HosEldEventsGetHosEldEventsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
EquipmentPatchEquipmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferDoorStateZone1WithDecorationsTypeResponseBody
object
Door stats that have been emitted by the reefer.
3 properties
2 required
HosEldEventsGetHosEldEventsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
EquipmentPatchEquipmentRequestBody
object
9 properties
TrailerStatReeferRunModeTypeResponseBody
object
The run mode of the reefer.
2 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone2WithDecorationsTypeResponseBody
object
Set point temperature of zone 2 of the reefer.
3 properties
2 required
TrailerStatsGetTrailerStatsHistoryNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
standardErrorResponse
object
Error response
2 properties
EngineImmobilizerUpdateEngineImmobilizerStateServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatsSnapshotObjectResponseBody
object
A trailer and its stats
25 properties
2 required
EngineImmobilizerUpdateEngineImmobilizerStateUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatReeferAmbientAirTemperatureWithDecorationsTypeResponseBody
object
Reefer ambient air temperature reading.
3 properties
2 required
GreenBandDrivingDurationMs
number
Time in efficient RPM (800 to 17000) in milliseconds.
TrailerStatReeferObdEngineSecondsWithDecorationsTypeResponseBody
object
Reefer onboard engine seconds reading.
3 properties
2 required
TrailerStatReeferStateZone2TypeResponseBody
object
Reefer state event.
3 properties
2 required
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
GoaAttributeTinyResponseBody
object
Attribute properties.
4 properties
EngineImmobilizerUpdateEngineImmobilizerStateGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerStatReeferDoorStateZone3WithDecorationsTypeResponseBody
object
Door stats that have been emitted by the reefer.
3 properties
2 required
paginationResponse
object
Pagination parameters.
2 properties
2 required
TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody
object
Reefer ambient air temperature reading.
2 properties
2 required
TrailerStatDecorationResponseBody
object
Decorated values for the primary trailer stat datapoints.
23 properties
TrailerStatReeferFuelPercentTypeResponseBody
object
The fuel percentage of the reefer.
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
HosEldEventsGetHosEldEventsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotResponseBody
object
2 properties
2 required
TrailerStatReeferDoorStateZone2WithDecorationsTypeResponseBody
object
Door stats that have been emitted by the reefer.
3 properties
2 required
PowerTakeOffDurationMs
number
Time spent with power take off enabled while idling in milliseconds.
TrailerStatsGetTrailerStatsFeedBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverEfficiency
object
Summary of a driver's efficiency.
14 properties
EngineImmobilizerUpdateEngineImmobilizerStateMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatsGetTrailerStatsFeedMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatsGetTrailerStatsFeedBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
HosEldEventObjectResponseBody
object
An event that refers to a discrete instance in time with various data elements. Depending on the type of event, not every field will be populated. For more inf…
13 properties
3 required
EquipmentPatchEquipmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
2 properties
2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone1WithDecorationsTypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
3 properties
2 required
TrailerStatGpsOdometerMetersTypeResponseBody
object
Trailer GPS odometer event.
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone3WithDecorationsTypeResponseBody
object
Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit.
3 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone3WithDecorationsTypeResponseBody
object
Set point temperature of zone 3 of the reefer.
3 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone3WithDecorationsTypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
3 properties
2 required
UpdateEngineImmobilizerRelayStateRequestBodyRequestBody
object
A request object to update a relay state.
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
GoaGatewayTinyResponseResponseBody
object
A minified gateway object
2 properties
2 required
HosEldEventsGetHosEldEventsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatReeferStateWithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone2WithDecorationsTypeResponseBody
object
Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit.
3 properties
2 required
EquipmentPatchEquipmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerStatReeferStateZone3WithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
TrailerStatsObjectResponseBody
object
A trailer and its stats
25 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody
object
Set point temperature of zone 1 of the reefer.
2 properties
2 required
EquipmentPatchEquipmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
CruiseControlDurationMs
number
Time spent in cruise control in milliseconds.
TrailerStatsGetTrailerStatsHistoryServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
EquipmentPatchEquipmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
HighTorqueMs
number
Time the vehicle engine torque is greater than 90% in milliseconds.
TrailerStatsGetTrailerStatsSnapshotTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverEfficienciesResponse_data
object
3 properties
HosEldEventsGetHosEldEventsResponseBody
object
2 properties
1 required
TrailerStatReeferDoorStateZone2TypeResponseBody
object
The door state of the reefer.
2 properties
2 required
TrailerStatReeferDoorStateZone3TypeResponseBody
object
The door state of the reefer.
2 properties
2 required
GoaAttributeTiny
object
Attribute properties.
4 properties
TrailerStatReeferSetPointTemperatureMilliCZone1WithDecorationsTypeResponseBody
object
Set point temperature of zone 1 of the reefer.
3 properties
2 required
TrailerStatReeferAlarmTypeResponseBody
object
Alarms that have been emitted by the reefer.
2 properties
2 required
EngineImmobilizerUpdateEngineImmobilizerStateInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatsGetTrailerStatsFeedServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
EquipmentPatchEquipmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatReeferRunModeWithDecorationsTypeResponseBody
object
The run mode of the reefer.
3 properties
2 required
TrailerStatsGetTrailerStatsHistoryGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
EquipmentPatchEquipmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody
object
Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit.
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
HosEldEventsGetHosEldEventsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
HosEldEventRemarkObjectResponseBody
object
3 properties
3 required
EngineImmobilizerUpdateEngineImmobilizerStateBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerStatReeferAlarmResponseBody
object
4 properties
4 required
EngineImmobilizerUpdateEngineImmobilizerStateBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody
object
Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit.
2 properties
2 required
vehicleTinyResponse
object
A minified vehicle object.
3 properties
EquipmentPatchEquipmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
GoaTagTinyResponseResponseBody
object
A minified tag object
3 properties
2 required
FuelConsumedMl
number
Fuel consumption in milliliters.
TrailerStatsGetTrailerStatsFeedResponseBody
object
2 properties
2 required
HosEldEventsGetHosEldEventsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryResponseBody
object
2 properties
2 required
TrailerStatGpsWithDecorationsTypeResponseBody
object
GPS location data for the trailer.
7 properties
3 required
TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody
object
Set point temperature of zone 3 of the reefer.
2 properties
2 required
TrailerStatsGetTrailerStatsFeedGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AnticipationBrakeEventCount
number
Quick braking events (less than one second after accelerating).
EngineImmobilizerUpdateEngineImmobilizerStateTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferStateZone3TypeResponseBody
object
Reefer state event.
3 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatReeferStateZone1WithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
HosEldEventsGetHosEldEventsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerStatReeferObdEngineSecondsTypeResponseBody
object
Reefer onboard engine seconds reading.
2 properties
2 required
EngineImmobilizerUpdateEngineImmobilizerStateRequestBody
object
A request body to update the engine immobilizer state.
1 property
1 required
TrailerStatReeferAlarmWithDecorationsTypeResponseBody
object
Alarms that have been emitted by the reefer.
3 properties
2 required
TrailerStatsGetTrailerStatsFeedUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatsGetTrailerStatsFeedNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
EquipmentPatchEquipmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatGpsTypeResponseBody
object
GPS location data for the trailer.
6 properties
3 required
ExtendedDriverTinyResponse
object
A minified driver object.
4 properties
DistanceDrivenMeters
number
Distance driven in meters.
TrailerStatGpsOdometerMetersWithDecorationsTypeResponseBody
object
Trailer GPS odometer event.
3 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone1WithDecorationsTypeResponseBody
object
Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit.
3 properties
2 required
HosDriversEldEventObjectResponseBody
object
5 properties
4 required
OverSpeedMs
number
Driving time spent over the efficient speed threshold in milliseconds.
HosEldEventsGetHosEldEventsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrailerStatsGetTrailerStatsFeedTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
HosEldEventsGetHosEldEventsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody
object
Set point temperature of zone 2 of the reefer.
2 properties
2 required
IdleTimeDurationMs
number
Time spent idling in milliseconds.
EquipmentWithAttributesResponseObjectResponseBody
object
The equipment object.
8 properties
CoastingDurationMs
number
Time spent without engaging the accelerator or brake in milliseconds.
ReverseGeoObjectResponseBody
object
Reverse geocoded information
1 property
EquipmentPatchEquipmentResponseBody
object
1 property
1 required
DriveTimeDurationMs
number
Time driven in milliseconds.
TotalBrakeEventCount
number
Total number of brake events.
EngineImmobilizerUpdateEngineImmobilizerStateNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatsGetTrailerStatsFeedInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverEfficienciesResponse
object
Summary of drivers' efficiencies over a time range.
2 properties
HosEldEventLocationObjectResponseBody
object
5 properties
TrailerStatReeferStateZone2WithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
EngineImmobilizerUpdateEngineImmobilizerStateNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone2WithDecorationsTypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
3 properties
2 required
TrailerStatReeferDoorStateZone1TypeResponseBody
object
The door state of the reefer.
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatsGetTrailerStatsFeedNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody
object
Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit.
2 properties
2 required
TrailerStatsGetTrailerStatsSnapshotServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
EquipmentPatchEquipmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatReeferStateTypeResponseBody
object
Reefer state event.
3 properties
2 required
TrailerStatsGetTrailerStatsSnapshotGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerStatReeferFuelPercentWithDecorationsTypeResponseBody
object
The fuel percentage of the reefer.
3 properties
2 required
TrailerStatsGetTrailerStatsHistoryBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
VehicleSummary
object
13 properties
TrailerStatReeferStateZone1TypeResponseBody
object
Reefer state event.
3 properties
2 required
HosEldEventsGetHosEldEventsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Samsara 12
Other APIs Samsara publishes across the network.
Samsara Activity API
Samsara Addresses API
Samsara Aemp API
Samsara Applications API
Samsara Assets API
Samsara Assignments API
Samsara Attributes API
Samsara Audit API
Samsara Beta A P Is API
Samsara Camera API
Samsara Cameras API
Samsara Cargo API
#Fleets
Where this information came from
This is an independent, third-party profile of Samsara Fleets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.