Sensors

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 <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 Write Sensors under the Equipment 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>

post/v1/sensors/cargo

Request

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

Request body

sensorsinteger[] required

List of sensor IDs to query.

Example request

{
  "sensors": [
    122
  ]
}

Response

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

groupIdinteger

Deprecated.

Example response

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

Changes

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