Samsara data contract | PatchOps Knowledge

Provenance

PublisherSamsara

API basehttps://api.samsara.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (Bearer token)

Methods (31)

listAssets

read

List assets (vehicles/trailers/equipment). Filter by tagIds.

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number",
      "examples": [
        100
      ]
    },
    "after": {
      "type": "string"
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

Returns id, name, type, regulationMode, createdAtTime.

listIndustrialAssets

read

List industrial assets (gateways/monitors/sensors).

Input schema

{
  "type": "object",
  "properties": {
    "after": {
      "type": "string"
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

Returns id, name, isRunning, location, dataInputs, dataOutputs, tags.

getIndustrialAsset

read

Get a single industrial asset by ID. Returns full detail including all data inputs and data outputs.

Required paramsassetId

Input schema

{
  "type": "object",
  "properties": {
    "assetId": {
      "type": "string",
      "examples": [
        "145cf277-c086-4807-a214-a404d9b40205"
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "assetId"
  ]
}

getIndustrialDataPoints

read

Get time-series for an industrial data input. dataInputId from listIndustrialAssets.

Required paramsdataInputIdstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "dataInputId": {
      "type": "string",
      "examples": [
        "826272695264"
      ]
    },
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-02T00:00:00Z"
      ]
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "dataInputId",
    "startTime",
    "endTime"
  ]
}

listVehicles

read

List vehicles from the Samsara fleet. Returns id, name, vin, make, model, year, licensePlate, tags.

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number",
      "examples": [
        50
      ]
    },
    "after": {
      "type": "string"
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

getVehicleLocations

read

Snapshot GPS for all vehicles. Returns lat, lng, speed, heading, address, time.

Input schema

{
  "type": "object",
  "properties": {
    "after": {
      "type": "string"
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

getVehicleLocationsFeed

read

Feed polling for vehicle locations. Pass endCursor as after on next calls.

Input schema

{
  "type": "object",
  "properties": {
    "after": {
      "type": "string"
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

getVehicleLocationsHistory

read

Get historical vehicle locations within a time range (ISO 8601).

Required paramsstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-02T00:00:00Z"
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime"
  ]
}

getVehicleStats

read

Snapshot vehicle stats. types required (max 3): gps, engineStates, fuelPercents, etc.

Required paramstypes

Input schema

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "decorations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "types"
  ]
}

getVehicleStatsFeed

read

Feed polling for vehicle stats. Poll >=5s. Returns changes since last cursor.

Required paramstypes

Input schema

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "decorations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "types"
  ]
}

getVehicleStatsHistory

read

Get historical vehicle stats within a time range.

Required paramstypesstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-02T00:00:00Z"
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "decorations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "types",
    "startTime",
    "endTime"
  ]
}

getEquipmentStats

read

Get current equipment stats snapshot. Same stat types as vehicles.

Required paramstypes

Input schema

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "equipmentIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "types"
  ]
}

getEquipmentStatsFeed

read

Feed-based polling for incremental equipment stat updates.

Required paramstypes

Input schema

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "equipmentIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "types"
  ]
}

getEquipmentStatsHistory

read

Get historical equipment stats within a time range.

Required paramstypesstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-02T00:00:00Z"
      ]
    },
    "equipmentIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "types",
    "startTime",
    "endTime"
  ]
}

getEquipmentLocationsFeed

read

Feed-based polling for equipment location updates.

Input schema

{
  "type": "object",
  "properties": {
    "equipmentIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

listDrivers

read

List drivers (active by default).

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "after": {
      "type": "string"
    },
    "driverActivationStatus": {
      "type": "string",
      "examples": [
        "deactivated"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "active"
          ]
        },
        {
          "type": "string",
          "enum": [
            "deactivated"
          ]
        }
      ]
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "createdAfterTime": {
      "type": "string"
    },
    "updatedAfterTime": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

Returns id, name, username, timezone, eldSettings, carrierSettings.

getDriver

read

Get a single driver by Samsara ID or external ID (e.g. tmsId:98765).

Required paramsdriverId

Input schema

{
  "type": "object",
  "properties": {
    "driverId": {
      "type": "string",
      "examples": [
        "12345"
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "driverId"
  ]
}

listAddresses

read

List addresses (geofences/yards).

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "after": {
      "type": "string"
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

Returns id, name, formattedAddress, lat/lng, geofence shape, types.

getAddress

read

Get a single address/geofence by ID.

Required paramsaddressId

Input schema

{
  "type": "object",
  "properties": {
    "addressId": {
      "type": "string",
      "examples": [
        "12684236"
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "addressId"
  ]
}

listContacts

read

List contacts in the organization. Returns id, firstName, lastName, email, phone.

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

listUsers

read

List users with their roles. Returns id, name, email, authType, roles.

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

listTrips

read

List historical trip records. Requires startTime and endTime (ISO 8601).

Required paramsstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-02T00:00:00Z"
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "limit": {
      "type": "number"
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime"
  ]
}

getHosClocks

read

Current HOS clocks. Shows remaining drive/on-duty/cycle/break time.

Input schema

{
  "type": "object",
  "properties": {
    "driverIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

getHosLogs

read

Get HOS log entries within a time range.

Required paramsstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-02T00:00:00Z"
      ]
    },
    "driverIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime"
  ]
}

getHosDailyLogs

read

Get daily HOS duty-status summaries. Uses date strings (YYYY-MM-DD).

Required paramsstartDateendDate

Input schema

{
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "examples": [
        "2026-03-01"
      ]
    },
    "endDate": {
      "type": "string",
      "examples": [
        "2026-03-07"
      ]
    },
    "driverIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startDate",
    "endDate"
  ]
}

getHosViolations

read

Get HOS violations within a time range.

Required paramsstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-08T00:00:00Z"
      ]
    },
    "driverIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime"
  ]
}

getSafetyEvents

read

Get safety events (harsh braking, acceleration, speeding, crashes) within a time range.

Required paramsstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-08T00:00:00Z"
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime"
  ]
}

listDvirs

read

List DVIRs (driver vehicle inspections) in a time range. Needs proper API scope.

Required paramsstartTimeendTime

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-08T00:00:00Z"
      ]
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime"
  ]
}

getDriverVehicleAssignments

read

Get driver-vehicle assignments within a time range. filterBy is required: "drivers" or "vehicles".

Required paramsstartTimeendTimefilterBy

Input schema

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "examples": [
        "2026-03-01T00:00:00Z"
      ]
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2026-03-08T00:00:00Z"
      ]
    },
    "filterBy": {
      "type": "string",
      "examples": [
        "vehicles"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "drivers"
          ]
        },
        {
          "type": "string",
          "enum": [
            "vehicles"
          ]
        }
      ]
    },
    "driverIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "vehicleIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "after": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "startTime",
    "endTime",
    "filterBy"
  ]
}

querySamsara

read

Generic Samsara API helper for any endpoint not covered by dedicated functions.

Required paramsendpoint

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string",
      "examples": [
        "/fleet/routes"
      ]
    },
    "method": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "POST"
          ]
        },
        {
          "type": "string",
          "enum": [
            "DELETE"
          ]
        },
        {
          "type": "string",
          "enum": [
            "PATCH"
          ]
        },
        {
          "type": "string",
          "enum": [
            "GET"
          ]
        },
        {
          "type": "string",
          "enum": [
            "PUT"
          ]
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "body": {},
    "expectBinary": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "endpoint"
  ]
}

Samsara

Provenance

Freshness & coverage

Methods (31)

listAssets

listIndustrialAssets

getIndustrialAsset

getIndustrialDataPoints

listVehicles

getVehicleLocations

getVehicleLocationsFeed

getVehicleLocationsHistory

getVehicleStats

getVehicleStatsFeed

getVehicleStatsHistory

getEquipmentStats

getEquipmentStatsFeed

getEquipmentStatsHistory

getEquipmentLocationsFeed

listDrivers

getDriver

listAddresses

getAddress

listTags

listContacts

listUsers

listTrips

getHosClocks

getHosLogs

getHosDailyLogs

getHosViolations

getSafetyEvents

listDvirs

getDriverVehicleAssignments

querySamsara