Get cargo status

This endpoint is still on our legacy API.

Get cargo monitor status (empty / full) for requested sensors.

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

POST /v1/sensors/cargo

Get cargo status

cURL

curl --request POST \
  --url https://api.samsara.com/v1/sensors/cargo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sensors": [
    122
  ]
}
'

200

{
  "groupId": 101,
  "sensors": [
    {
      "cargoEmpty": true,
      "cargoStatusTime": "2019-04-17T16:42:55Z",
      "id": 122,
      "name": "Trailer Cargo V1Sensor",
      "redEyeDistance": 175,
      "trailerId": 123,
      "vehicleId": 124
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

List of sensor IDs to query.

sensors · integer<int64>[] · required

List of sensor IDs to query.

Example:

[122]

Response

200

application/json

List of sensor objects containing the current cargo status reported by each sensor.

Contains the current cargo status of a sensor.

groupId · integer<int64>

Deprecated.

Example:

101

sensors · object[]

Show child attributes