Get trailer stats

Returns the last known stats of all trailers at the given time. If no time is specified, the current time is used.

Rate limit: 25 requests/sec (learn more about rate limits here).

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

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.

GET /fleet/trailers/stats

Get trailer stats

cURL

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

200

{
  "data": [
    {
      "id": "1234",
      "name": "Trailer-123",
      "carrierReeferState": {
        "time": "2020-01-27T07:06:25Z",
        "value": "`Off`, `On`",
        "substateValue": "`Pretrip`, `Defrost`"
      },
      "gps": {
        "latitude": 0.11331136118623318,
        "longitude": 0.2965517819045647,
        "time": "2020-01-27T07:06:25Z",
        "headingDegrees": 5631003136208764000,
        "reverseGeo": {
          "formattedLocation": "850 Made Up Lane, Orange, CA"
        },
        "speedMilesPerHour": 6500481596243475000
      },
      "gpsOdometerMeters": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferAlarms": {
        "alarms": [
          {
            "alarmCode": "3",
            "description": "Test alarm",
            "operatorAction": "Manually disable alarm",
            "severity": 5406015254738261000
          }
        ],
        "time": "2020-01-27T07:06:25Z"
      },
      "reeferAmbientAirTemperatureMilliC": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferDoorStateZone1": {
        "time": "2020-01-27T07:06:25Z",
        "value": "closed"
      },
      "reeferDoorStateZone2": {
        "time": "2020-01-27T07:06:25Z",
        "value": "closed"
      },
      "reeferDoorStateZone3": {
        "time": "2020-01-27T07:06:25Z",
        "value": "closed"
      },
      "reeferFuelPercent": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferObdEngineSeconds": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferReturnAirTemperatureMilliCZone1": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferReturnAirTemperatureMilliCZone2": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferReturnAirTemperatureMilliCZone3": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferRunMode": {
        "time": "2020-01-27T07:06:25Z",
        "value": "`Start/Stop`,`Continuous`"
      },
      "reeferSetPointTemperatureMilliCZone1": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferSetPointTemperatureMilliCZone2": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferSetPointTemperatureMilliCZone3": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferStateZone1": {
        "time": "2020-01-27T07:06:25Z",
        "value": "`Off`, `On`",
        "substateValue": "`Pretrip`, `Defrost`"
      },
      "reeferStateZone2": {
        "time": "2020-01-27T07:06:25Z",
        "value": "`Off`, `On`",
        "substateValue": "`Pretrip`, `Defrost`"
      },
      "reeferStateZone3": {
        "time": "2020-01-27T07:06:25Z",
        "value": "`Off`, `On`",
        "substateValue": "`Pretrip`, `Defrost`"
      },
      "reeferSupplyAirTemperatureMilliCZone1": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferSupplyAirTemperatureMilliCZone2": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      },
      "reeferSupplyAirTemperatureMilliCZone3": {
        "time": "2020-01-27T07:06:25Z",
        "value": 50
      }
    }
  ],
  "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

types · string · required

The stat types you want this endpoint to return information on.

You may list up to 3 types using comma-separated format. For example: types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters.

• gps: GPS data including lat/long, heading, speed, and a reverse geocode address.
• gpsOdometerMeters: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the cloud dashboard. Odometer readings wthat are manually set will update as GPS trip data is gathered.
• reeferAmbientAirTemperatureMilliC: The ambient air temperature reading of the reefer in millidegree Celsius.
• reeferObdEngineSeconds: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions.
• reeferSupplyAirTemperatureMilliCZone1: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.
• reeferSupplyAirTemperatureMilliCZone2: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions.
• reeferSupplyAirTemperatureMilliCZone3: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions.
• reeferFuelPercent: The fuel level of the reefer unit in percentage points (e.g. 99, 50, etc). Only supported on reefer solutions.
• carrierReeferState: The overall state of the reefer (Off, On). Only supported on multizone Carrier reefer solutions.
• reeferStateZone1: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions.
• reeferStateZone2: The state of the reefer in zone 2. Only supported on multizone reefer solutions.
• reeferStateZone3: The state of the reefer in zone 3. Only supported on multizone reefer solutions.
• reeferRunMode: The operational mode of the reefer (Start/Stop, Continuous)
• reeferAlarms: Any alarms that are present on the reefer. Only supported on reefer solutions.
• reeferReturnAirTemperatureMilliCZone1: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.
• reeferReturnAirTemperatureMilliCZone2: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.
• reeferReturnAirTemperatureMilliCZone3: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.
• reeferSetPointTemperatureMilliCZone1: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.
• reeferSetPointTemperatureMilliCZone2: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.
• reeferSetPointTemperatureMilliCZone3: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.
• reeferDoorStateZone1: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone.
• reeferDoorStateZone2: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions.
• reeferDoorStateZone3: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.

tagIds · string

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

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

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.

trailerIds · string

A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186

time · string

A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 Format. Millisecond precision and timezones are supported.

Response

200

application/json

OK response.

data · object[] · required

List of trailers and their stats

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes