Follow feed of equipment locations

Follow a continuous feed of all equipment locations.

Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a pagination object that contains an endCursor.

You can provide the endCursor to subsequent calls via the after parameter. The response will contain any equipment location updates since that endCursor.

If hasNextPage is false, no updates are readily available yet. We’d suggest waiting a minimum of 5 seconds before requesting updates.

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 Equipment Statistics under the Equipment category when creating or editing an API token. Learn More.

GET /fleet/equipment/locations/feed

Follow feed of equipment locations

cURL

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

200

{
  "data": [
    {
      "id": "112",
      "locations": [
        {
          "latitude": 122.142,
          "longitude": -93.343,
          "time": "2020-01-27T07:06:25Z",
          "heading": 120,
          "speed": 48.3
        }
      ],
      "name": "Crane 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.

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

equipmentIds · string[]

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

Response

200

application/json

The feed of equipment locations and pagination information

A time-series of equipment locations and pagination information

data · object[] · required

Time-series of locations for the specified units of equipment.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes