SAsamsara
Beta APIs

[beta] Get driver HOS ELD events

Get all HOS ELD events in a time range, grouped by driver. Attributes will be populated depending on which ELD Event Type is being returned.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read ELD Compliance Settings (US) under the Compliance category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/beta/fleet/hos/drivers/eld-events

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

startTimestring required

A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

endTimestring required

An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

driverIdsstring[]

A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: driverIds=1234,5678,payroll:4841

tagIdsstring

A filter on the data based on this comma-separated list of tag IDs. Example: tagIds=1234,5678

parentTagIdsstring

A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: parentTagIds=345,678

driverActivationStatus'active' | 'deactivated'

If value is deactivated, only drivers that are deactivated will appear in the response. This parameter will default to active if not provided (fetching only active drivers). Valid values: active, deactivated

afterstring

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 25 objects.

Response

OK response.

Example response

{
  "data": [
    {
      "driverActivationStatus": "active",
      "eldEvents": [
        {
          "accumulatedVehicleMeters": 106,
          "elapsedEngineHours": 284.1,
          "eldEventCode": 3,
          "eldEventRecordOrigin": 2,
          "eldEventRecordStatus": 2,
          "eldEventType": 6,
          "location": {
            "city": "San Francisco",
            "eldLocation": "3.1 mi WSW San Francisco, CA",
            "latitude": 123.456,
            "longitude": 37.459,
            "state": "CA"
          },
          "malfunctionDiagnosticCode": "P",
          "remark": {
            "comment": "Pre-Trip Inspection",
            "locationDescription": "Near San Francisco",
            "time": "2019-06-13T19:08:25Z"
          },
          "time": "2019-06-13T19:08:25Z",
          "totalEngineHours": 2894.1,
          "totalVehicleMeters": 1004566,
          "vehicle": {
            "id": "494123",
            "name": "Fleet Truck #1"
          }
        }
      ],
      "id": "494123",
      "name": "Joe Driver"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.