Get Route Updates

Retrieve route updates within a specified time range from Samsara.

Operation

getRouteUpdates

Resource

route

Parameters

Parameter	Type	Required	Default	Description
Start Time	dateTime	Yes	-	Start of the time range for route updates (RFC 3339 format)

Options

Option	Type	Default	Description
End Time	dateTime	-	End of the time range for route updates (RFC 3339 format)
Tag IDs	string	-	Comma-separated list of tag IDs to filter routes by
Include Debug Info	boolean	false	Whether to include metadata about the API request

Response

Success

Returns an array of route records with updates:

{
  "id": "route_123",
  "name": "Morning Delivery Route",
  "actualStartTime": "2024-01-15T09:55:00Z",
  "actualEndTime": "2024-01-15T14:30:00Z",
  "stops": [
    {
      "id": "stop_1",
      "state": "completed",
      "actualArrivalTime": "2024-01-15T10:05:00Z",
      "actualDepartureTime": "2024-01-15T10:15:00Z"
    }
  ]
}

With debug info enabled:

{
  "id": "route_123",
  "name": "Morning Delivery Route",
  "_metadata": {
    "totalRoutes": 10,
    "startTime": "2024-01-15T00:00:00Z",
    "endTime": "2024-01-15T23:59:59Z"
  }
}

Error

{
  "success": false,
  "error": "Invalid date format",
  "startTime": "invalid"
}

Error Handling

• Missing API Token: Samsara credential is missing apiToken
• Invalid Date Format: Start/end time is not in RFC 3339 format
• Rate Limiting: API rate limit exceeded