Routes, Sensors, and Cameras

Vehicle route history, temperature/humidity reports, sensor inventory, and camera event helpers.

Route and sensor report endpoints can return large payloads. Use pagination, date ranges, and field projection deliberately.

routes.getVehicleRoutes()

GET

Get vehicle route history

/vehicles/{vehicleId}/routeslinxio.routes.getVehicleRoutes(vehicleId, params)

Fetches route history for one vehicle. Request coordinates only when you need every recorded point.

Input

vehicleId

LinxioId

required

Vehicle identifier.

params.dateFrom

ISODateString

optional

Start date/time.

params.dateTo

ISODateString

optional

End date/time.

params.fields

RouteField[]

optional

Optional route fields such as coordinates, driver, vehicle, or address.

params.limit

number

optional

Limit accepted by the route endpoint.

params.page

number

optional

Page accepted by the route endpoint.

Returns

data

LinxioVehicleRoutesGroup[] | null

optional

Route groups by vehicle/driver, each with route segments.

error

LinxioError | null

optional

Typed SDK error when routes cannot be loaded.

Route history

const routes = await linxio.routes.getVehicleRoutes(vehicleId, {
  dateFrom: "2026-06-01T00:00:00+08:00",
  dateTo: "2026-06-08T00:00:00+08:00",
  fields: ["address"],
});

if (routes.error) {
  throw routes.error;
}

Include coordinates only when needed

const routesWithPoints = await linxio.routes.getVehicleRoutes(vehicleId, {
  dateFrom,
  dateTo,
  fields: ["coordinates"],
});

sensors.list()

GET

List sensors

/sensorslinxio.sensors.list()

Lists sensors visible to the authenticated account.

Input

none

void

optional

list() does not take parameters.

Returns

data

LinxioSensor[] | null

optional

Sensor records.

error

LinxioError | null

optional

Typed SDK error when sensors cannot be loaded.

sensors.get()

GET

Get a sensor

/sensors/{sensorId}linxio.sensors.get(sensorId)

Fetches one sensor by ID.

Input

sensorId

LinxioId

required

Sensor identifier.

Returns

data

LinxioSensor | null

optional

Sensor record.

error

LinxioError | null

optional

Typed SDK error when the sensor cannot be loaded.

sensors.install()

POST

Install a sensor

/sensors/{sensorId}/installlinxio.sensors.install(sensorId, deviceId)

Pairs or installs a sensor with a device.

Input

sensorId

LinxioId

required

Sensor identifier.

deviceId

LinxioId

required

Device identifier.

Returns

data

LinxioSensor | null

optional

Updated sensor record.

error

LinxioError | null

optional

Typed SDK error when install fails.

sensors.deviceTemperatureHumidityReport()

GET

List device temperature and humidity readings

/devices/sensors/report/temp-and-humiditylinxio.sensors.deviceTemperatureHumidityReport(params)

Loads one page of temperature/humidity readings grouped by device sensor.

Input

params.startDate / params.endDate

ISODateString

optional

Optional report date range.

params.dateFrom / params.dateTo

ISODateString

optional

Alternative date range names accepted by some Linxio report flows.

params.sensorId

LinxioId

optional

Optional sensor filter.

params.vehicleId

LinxioId

optional

Optional vehicle filter.

params.limit

number

optional

Number of readings to request.

Returns

data

LinxioTemperatureHumidityReading[] | null

optional

Temperature/humidity readings for the requested page.

meta

LinxioPaginationMeta | null

optional

Pagination metadata.

error

LinxioError | null

optional

Typed SDK error when readings cannot be loaded.

Device temp/humidity report

const report = await linxio.sensors.deviceTemperatureHumidityReport({
  startDate: "2026-06-01T00:00:00+08:00",
  endDate: "2026-06-08T00:00:00+08:00",
  limit: 100,
});

if (report.error) {
  throw report.error;
}

sensors.vehicleTemperatureHumidityReport()

GET

List vehicle temperature and humidity readings

/vehicles/report/sensors/temp-and-humiditylinxio.sensors.vehicleTemperatureHumidityReport(params)

Loads one page of temperature/humidity readings grouped by vehicle.

Input

params

LinxioSensorReportParams

optional

Date range, pagination, sensorId, vehicleId, and other report filters.

Returns

data

LinxioTemperatureHumidityReading[] | null

optional

Temperature/humidity readings for the requested page.

meta

LinxioPaginationMeta | null

optional

Pagination metadata.

error

LinxioError | null

optional

Typed SDK error when readings cannot be loaded.

sensors.iterateDeviceTemperatureHumidityReport()

GET

Load all device temperature and humidity readings

/devices/sensors/report/temp-and-humiditylinxio.sensors.iterateDeviceTemperatureHumidityReport(params)

Auto-paginates the device temperature/humidity report into one result object.

Input

params

LinxioSensorReportParams

optional

Same parameters as deviceTemperatureHumidityReport().

Returns

data

LinxioTemperatureHumidityReading[] | null

optional

Flat array containing every loaded reading.

error

LinxioError | null

optional

Typed SDK error if any page fails.

sensors.streamDeviceTemperatureHumidityReport()

GET

Stream device temperature and humidity readings

/devices/sensors/report/temp-and-humiditylinxio.sensors.streamDeviceTemperatureHumidityReport(params)

Streams device temperature/humidity readings lazily across pages.

Input

params

LinxioSensorReportParams

optional

Same parameters as deviceTemperatureHumidityReport().

Returns

yield

LinxioTemperatureHumidityReading

optional

One reading at a time.

throws

LinxioError

optional

Thrown if a page request fails.

Stream sensor report

for await (const reading of linxio.sensors.streamDeviceTemperatureHumidityReport({
  startDate,
  endDate,
  limit: 100,
})) {
  console.log(reading.occurredAt, reading.temperature, reading.humidity);
}

cameras.events()

GET

List camera events

/devices/cameras/eventslinxio.cameras.events(params)

Loads one page of camera events. Event fields can vary by camera provider and tenant configuration.

Input

params

ListParams

optional

Pagination, field projection, sorting, and camera-event filters.

Returns

data

LinxioRecord[] | null

optional

Camera event records.

meta

LinxioPaginationMeta | null

optional

Pagination metadata.

error

LinxioError | null

optional

Typed SDK error when camera events cannot be loaded.

cameras.eventTypes()

GET

List camera event types

/devices/cameras/events/typeslinxio.cameras.eventTypes()

Lists camera event types known to Linxio.

Input

none

void

optional

eventTypes() does not take parameters.

Returns

data

LinxioRecord[] | null

optional

Camera event type records.

error

LinxioError | null

optional

Typed SDK error when event types cannot be loaded.

Routes, Sensors, and Cameras

Get vehicle route history

Input

Returns

List sensors

Input

Returns

Get a sensor

Input

Returns

Install a sensor

Input

Returns

List device temperature and humidity readings

Input

Returns

List vehicle temperature and humidity readings

Input

Returns

Load all device temperature and humidity readings

Input

Returns

Stream device temperature and humidity readings

Input

Returns

List camera events

Input

Returns

List camera event types

Input

Returns

On this page