SAsamsara
Vehicle Locations

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: <a href="/docs/vehicle-locations-1" target="_blank">Vehicle Locations</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.

To use this endpoint, select Read Vehicle Statistics under the Vehicle 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>

get/fleet/vehicles/locations/history

Request

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

Query parameters

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.

startTimestring 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).

endTimestring 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).

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

tagIdsstring[]

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

vehicleIdsstring[]

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

Response

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

Example response

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

Changes

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