{
"opencollection": "1.0.0",
"info": {
"name": "Samsara Events API",
"version": "2024-11-18"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "[beta] Get Driver HOS ELD Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/beta/fleet/hos/drivers/eld-events",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": " 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)."
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": " 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)."
},
{
"name": "driverIds",
"value": "",
"type": "query",
"description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`"
},
{
"name": "tagIds",
"value": "",
"type": "query",
"description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`"
},
{
"name": "parentTagIds",
"value": "",
"type": "query",
"description": " 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`"
},
{
"name": "driverActivationStatus",
"value": "",
"type": "query",
"description": "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`"
},
{
"name": "after",
"value": "",
"type": "query",
"description": " 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."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The limit for how many objects will be in the response. Default and max for this value is 25 objects."
}
]
},
"docs": "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.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch harsh event details for a vehicle. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case"
}
]
}
],
"bundled": true
}