Routes, Sensors, and Cameras

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

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.

Important

Vehicle route history can return large payloads. Use date ranges and field projection deliberately. If your tenant has many vehicles and/or vehicles with long route histories, avoid using routes.getVehicleRoutes() in production implementations.

Input

LinxioId

required

Vehicle identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

ISODateString

optional

Start date/time.

ISODateString

optional

End date/time.

RouteField[]

optional

Route fields to include in the response projection.

Possible enum values

coordinates

Route coordinate points. This can produce large responses.

driver

Driver summary for each route.

vehicle

Vehicle summary for each route.

address

Resolved start/finish addresses.

number

optional

Limit accepted by the route endpoint.

number

optional

Page accepted by the route endpoint.

Returns

LinxioVehicleRoutesGroup[] | null

optional

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

Show child fields

LinxioId | null

optional

Driver identifier.

LinxioVehicleRoute[]

required

Route segments for the group.

LinxioId

required

Vehicle identifier.

LinxioError | null

optional

Typed SDK error when routes cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

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"],
});

Example response


{
  "data": [
    {
      "driverId": "36541",
      "routes": [
        {
          "address": "string",
          "avgSpeed": 0,
          "comment": "string",
          "coordinates": [
            {}
          ],
          "deviceId": 124210,
          "distance": 0,
          "driverId": "36541",
          "duration": 0,
          "id": 64553,
          "maxSpeed": 123,
          "pointFinish": {},
          "pointStart": {},
          "scope": {},
          "type": "Truck",
          "vehicleId": 64553
        }
      ],
      "vehicleId": 64553
    }
  ],
  "error": null
}

sensors.list()

GET

List sensors

/sensorslinxio.sensors.list(params)

Lists sensors visible to the authenticated account.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of sensors to request.

number

optional

Page number to request.

Default: 1

SensorField[]

optional

Sensor fields to include in the response projection.

Possible enum values

id

Sensor identifier.

label

Sensor display label.

sensorId

Hardware sensor identifier.

systemStatus

Sensor system status.

team

Owning team summary.

type

Sensor type.

Returns

LinxioSensor[] | null

optional

Sensor records for the requested page.

Show child fields

ISODateString | null

optional

Sensor creation timestamp.

LinxioId | null

optional

Device identifier.

LinxioId

required

Sensor identifier.

string | null

optional

Sensor display label.

string | null

optional

Hardware sensor identifier.

string | null

optional

Sensor system status.

LinxioRecord | null

optional

Owning team summary.

string | null

optional

Sensor type.

ISODateString | null

optional

Last update timestamp.

LinxioId | null

optional

Vehicle identifier.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when sensors cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

List sensors

const sensors = await linxio.sensors.list({
  limit: 25,
  page: 1,
});

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

Example response


{
  "data": [
    {
      "createdAt": "2026-01-15T04:07:48+00:00",
      "deviceId": 124210,
      "id": 64553,
      "label": "Example Label",
      "sensorId": "string",
      "systemStatus": "active",
      "team": {
        "id": 5932,
        "type": "client",
        "clientId": 5598,
        "resellerId": null,
        "resellerName": null,
        "clientName": "EXAMPLE CLIENT"
      },
      "type": "Truck",
      "updatedAt": "2026-05-30T00:35:15+00:00",
      "vehicleId": 64553
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

sensors.get()

GET

Get a sensor

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

Fetches one sensor by ID.

Input

LinxioId

required

Sensor identifier.

Returns

LinxioSensor | null

optional

Sensor record.

Show child fields

ISODateString | null

optional

Sensor creation timestamp.

LinxioId | null

optional

Device identifier.

LinxioId

required

Sensor identifier.

string | null

optional

Sensor display label.

string | null

optional

Hardware sensor identifier.

string | null

optional

Sensor system status.

LinxioRecord | null

optional

Owning team summary.

string | null

optional

Sensor type.

ISODateString | null

optional

Last update timestamp.

LinxioId | null

optional

Vehicle identifier.

LinxioError | null

optional

Typed SDK error when the sensor cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Get sensor

const sensor = await linxio.sensors.get(sensorId);

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

Example response


{
  "data": {
    "createdAt": "2026-01-15T04:07:48+00:00",
    "deviceId": 124210,
    "id": 64553,
    "label": "Example Label",
    "sensorId": "string",
    "systemStatus": "active",
    "team": {
      "id": 5932,
      "type": "client",
      "clientId": 5598,
      "resellerId": null,
      "resellerName": null,
      "clientName": "EXAMPLE CLIENT"
    },
    "type": "Truck",
    "updatedAt": "2026-05-30T00:35:15+00:00",
    "vehicleId": 64553
  },
  "error": null
}

sensors.install()

POST

Install a sensor

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

Pairs or installs a sensor with a device.

Input

LinxioId

required

Sensor identifier.

LinxioId

required

Device identifier.

Returns

LinxioSensor | null

optional

Updated sensor record.

Show child fields

ISODateString | null

optional

Sensor creation timestamp.

LinxioId | null

optional

Device identifier.

LinxioId

required

Sensor identifier.

string | null

optional

Sensor display label.

string | null

optional

Hardware sensor identifier.

string | null

optional

Sensor system status.

LinxioRecord | null

optional

Owning team summary.

string | null

optional

Sensor type.

ISODateString | null

optional

Last update timestamp.

LinxioId | null

optional

Vehicle identifier.

LinxioError | null

optional

Typed SDK error when install fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Install sensor

const installed = await linxio.sensors.install(sensorId, deviceId);

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

Example response


{
  "data": {
    "createdAt": "2026-01-15T04:07:48+00:00",
    "deviceId": 124210,
    "id": 64553,
    "label": "Example Label",
    "sensorId": "string",
    "systemStatus": "active",
    "team": {
      "id": 5932,
      "type": "client",
      "clientId": 5598,
      "resellerId": null,
      "resellerName": null,
      "clientName": "EXAMPLE CLIENT"
    },
    "type": "Truck",
    "updatedAt": "2026-05-30T00:35:15+00:00",
    "vehicleId": 64553
  },
  "error": null
}

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

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

ISODateString

optional

Optional report date range.

ISODateString

optional

Alternative date range names accepted by some Linxio report flows.

LinxioId

optional

Optional sensor filter.

LinxioId

optional

Optional vehicle filter.

number

optional

Number of readings to request.

Returns

LinxioTemperatureHumidityReading[] | null

optional

Temperature/humidity readings for the requested page.

Show child fields

number | null

optional

Humidity reading.

ISODateString

optional

Reading timestamp.

LinxioId

optional

Sensor identifier.

number | null

optional

Temperature reading.

LinxioId

optional

Vehicle identifier.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when readings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

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;
}

Example response


{
  "data": [
    {
      "humidity": 123,
      "occurredAt": "2026-06-08T12:00:00+08:00",
      "sensorId": 64553,
      "temperature": 123,
      "vehicleId": 64553
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

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

LinxioSensorReportParams

optional

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

Show child parameters

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

LinxioId

optional

Sensor identifier filter.

LinxioId

optional

Vehicle identifier filter.

ISODateString

optional

Date range for the sensor report.

Returns

LinxioTemperatureHumidityReading[] | null

optional

Temperature/humidity readings for the requested page.

Show child fields

number | null

optional

Humidity reading.

ISODateString

optional

Reading timestamp.

LinxioId

optional

Sensor identifier.

number | null

optional

Temperature reading.

LinxioId

optional

Vehicle identifier.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when readings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Vehicle temp/humidity report

const report = await linxio.sensors.vehicleTemperatureHumidityReport({
  vehicleId,
  startDate,
  endDate,
  limit: 100,
});

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

Example response


{
  "data": [
    {
      "humidity": 123,
      "occurredAt": "2026-06-08T12:00:00+08:00",
      "sensorId": 64553,
      "temperature": 123,
      "vehicleId": 64553
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

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.

Important

Device temperature and humidity reports can return large payloads, especially when using the iterate method. Use pagination, date ranges, and field projection deliberately. Avoid using iterate() in production implementations. It is better to use sensors.streamDeviceTemperatureHumidityReport() for lazy async iteration where possible.

Input

LinxioSensorReportParams

optional

Same parameters as deviceTemperatureHumidityReport().

Show child parameters

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

LinxioId

optional

Sensor identifier filter.

LinxioId

optional

Vehicle identifier filter.

ISODateString

optional

Date range for the sensor report.

Returns

LinxioTemperatureHumidityReading[] | null

optional

Flat array containing every loaded reading.

Show child fields

number | null

optional

Humidity reading.

ISODateString

optional

Reading timestamp.

LinxioId

optional

Sensor identifier.

number | null

optional

Temperature reading.

LinxioId

optional

Vehicle identifier.

LinxioError | null

optional

Typed SDK error if any page fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Iterate sensor report

const { data: readings, error } =
  await linxio.sensors.iterateDeviceTemperatureHumidityReport({
    startDate,
    endDate,
    limit: 100,
  });

if (error) {
  throw error;
}

Example response


{
  "data": [
    {
      "humidity": 123,
      "occurredAt": "2026-06-08T12:00:00+08:00",
      "sensorId": 64553,
      "temperature": 123,
      "vehicleId": 64553
    }
  ],
  "error": null
}

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

LinxioSensorReportParams

optional

Same parameters as deviceTemperatureHumidityReport().

Show child parameters

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

LinxioId

optional

Sensor identifier filter.

LinxioId

optional

Vehicle identifier filter.

ISODateString

optional

Date range for the sensor report.

Returns

LinxioTemperatureHumidityReading

optional

One reading at a time.

Show child fields

number | null

optional

Humidity reading.

ISODateString

optional

Reading timestamp.

LinxioId

optional

Sensor identifier.

number | null

optional

Temperature reading.

LinxioId

optional

Vehicle identifier.

LinxioError

optional

Thrown if a page request fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Stream sensor report

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

Example response


{
  "yield": {
    "humidity": 123,
    "occurredAt": "2026-06-08T12:00:00+08:00",
    "sensorId": 64553,
    "temperature": 123,
    "vehicleId": 64553
  }
}

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

ListParams

optional

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

Returns

LinxioRecord[] | null

optional

Camera event records.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when camera events cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Camera events

const events = await linxio.cameras.events({
  limit: 100,
  page: 1,
});

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

Example response


{
  "data": [
    {}
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

cameras.eventTypes()

GET

List camera event types

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

Lists camera event types known to Linxio.

Input

void

optional

eventTypes() does not take parameters.

Returns

LinxioRecord[] | null

optional

Camera event type records.

LinxioError | null

optional

Typed SDK error when event types cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

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