Streaming

get_data stream

A vehicle-status record is pushed to the client's Kinesis stream per unit, event-driven, as the unit reports.

Record envelope

Each Kinesis record's Data field is a base64-encoded JSON envelope. For this stream apiName is vehicle_status_updated.

{
  "clientId": "numaris",
  "apiName": "vehicle_status_updated",
  "eventLatency": "int",
  "payload": {
    "unit_key": "1:905003453",
    "unit_type": "1",
    "inner_id": "905003453",
    "unit_id": 98765,
    "date": "2026-06-24T08:14:55Z",
    "server_time": "2026-06-24T08:15:17Z",
    "latitude": 32.0853,
    "longitude": 34.7818,
    "speed": 62,
    "direction": 180,
    "mileage": 152340,
    "fuel_used": 18.4,
    "ignition": 1,
    "satellites": 11,
    "engine_hours": 4210,
    "vehicle_id": "555",
    "group_id": "42",
    "group_name": "RFP",
    "client_id": "13648",
    "client_name": "Traxion Carga",
    "company_number": "20401",
    "license_plate": "AB-123-CD",
    "vin": "3HSDJAPR8JN000000",
    "manufacturer": "International",
    "model": "TRUCK-J1939-SCR-CNT",
    "sub_model": "A79",
    "current_driver": "7788",
    "driver_name": "Juan Pérez",
    "worker_id": "EMP-3391",
    "current_driver_number": "104",
    "current_drive": "660912",
    "last_event_time": "2026-06-24T08:14:40Z",
    "last_event_type": "Ignition on",
    "charge_hours": "0",
    "status": 1
  }
}

Partition key

The Kinesis partition key for every record is "<unitType>:<innerId>", for example 1:905003453. All records for the same physical unit land on the same shard, preserving per-unit ordering.

Payload fields

NameTypeRequiredDescription
unit_keystringrequiredComposite unit key (unitType:innerId).
unit_typestringrequiredUnit type code (e.g. '1').
inner_idstringrequiredUnit's inner hardware identifier.
unit_idnumberrequiredTelematics unit identifier.
datestringrequiredUnit event timestamp (ISO 8601).
server_timestringrequiredServer ingestion timestamp (ISO 8601).
latitudenumberrequiredGPS latitude.
longitudenumberrequiredGPS longitude.
speednumberrequiredSpeed at record time.
directionnumberrequiredHeading in degrees (0–359).
mileagenumberrequiredOdometer reading.
fuel_usednumberrequiredFuel consumed (trip accumulator).
ignitionnumberrequiredIgnition state: 1=on, 0=off.
satellitesnumberrequiredNumber of GPS satellites in use.
engine_hoursnumberrequiredCumulative engine hours.
vehicle_idstringrequiredInternal vehicle identifier.
group_idstringrequiredDepot/group identifier.
group_namestringrequiredDepot/group display name.
client_idstringrequiredTenant/client identifier.
client_namestringrequiredTenant/client display name.
company_numberstringrequiredClient company registration number.
license_platestringrequiredVehicle license plate.
vinstringrequiredVehicle VIN / chassis serial.
manufacturerstringrequiredVehicle manufacturer name.
modelstringrequiredVehicle model name.
sub_modelstringrequiredVehicle sub-model or trim.
current_driverstringrequiredActive driver identifier.
driver_namestringrequiredActive driver display name.
worker_idstringrequiredActive driver's worker/employee identifier.
current_driver_numberstringrequiredActive driver code / badge number.
current_drivestringrequiredActive trip/drive identifier.
last_event_timestringrequiredTimestamp of the most recent event.
last_event_typestringrequiredDescription of the most recent event type.
charge_hoursstringrequiredCumulative charge hours (EVs).
statusnumberrequiredVehicle status code (e.g. 1=moving, 0=idle).