Historical locations

NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new Vehicle Stats API instead.

Returns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs.

Related guide: Vehicle Locations.

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 to our support team.

To use this endpoint, select Read Vehicle Statistics under the Vehicle category when creating or editing an API token. Learn More.

GET /fleet/vehicles/locations/history

Historical locations

cURL

curl --request GET \
  --url https://api.samsara.com/fleet/vehicles/locations/history \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "112",
      "locations": [
        {
          "latitude": 122.142,
          "longitude": -93.343,
          "time": "2020-01-27T07:06:25Z",
          "heading": 120,
          "reverseGeo": {
            "formattedLocation": "16 N Fair Oaks Ave, Pasadena, CA 91103"
          },
          "speed": 48.3
        }
      ],
      "name": "Truck A7"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

after · string

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.

startTime · string · required

A start time in RFC 3339 format. 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).

endTime · string · required

An end time in RFC 3339 format. 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).

parentTagIds · string[]

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

tagIds · string[]

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

vehicleIds · string[]

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

Response

200

application/json

List of all locations for the specified vehicles and time range.

List of vehicle location events and pagination info.

data · object[] · required

A list of vehicles and an array of location events for each vehicle.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes