Tracking Events API 1.0.0 documentation
AsyncAPI documentation for the Tracking events stream. Tracking events represent real-time vehicle telemetry data including GPS position, speed, fuel levels, driver information, tachograph data, TPMS sensors, and EBS brake system data.Table of Contents
Servers
kafka Server
- URL:
kafka-secure://{brokerHost}:{brokerPort}/ - Protocol:
kafka-secure
URL Variables
| Name | Description | Default value | Allowed values |
|---|---|---|---|
| brokerHost | Kafka broker hostname | localhost | Any |
| brokerPort | Kafka broker port | 9092 | Any |
Security
Security Requirement 1
- security.protocol: SASL_SSL
- sasl.mechanism: OAUTHBEARER
Operations
RECEIVE mn_tracking_events Operation
Receive tracking events
- Operation ID:
receiveTrackingEvent
Message Tracking Event TrackingEvent
A real-time vehicle tracking event
- Message ID:
trackingEvent - Content type: application/json
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object | - | - | - | additional properties are allowed |
| id | string | Unique identifier of the tracking event | - | - | required |
| cid | string | Customer identifier | - | - | required |
| esn | string | Device serial number | - | - | - |
| aid | string | Asset (vehicle) identifier | - | - | required |
| an | string | Asset name | - | - | - |
| amk | string | Asset make | - | - | - |
| amd | string | Asset model | - | - | - |
| at | string | Asset type | - | - | - |
| edt | integer | Event date time in epoch milliseconds | - | format (int64) | required |
| ngps | integer | Number of GPS satellites | - | - | - |
| hdop | number | Horizontal Dilution of Precision | - | format (float) | - |
| eca | integer | Event category | - | - | - |
| eco | integer | Event code | - | - | - |
| es | string | Event status | - | - | - |
| dk | string | Driver key | - | - | - |
| pid | string | Person (driver) identifier | - | - | - |
| pn | string | Person name | - | - | - |
| opid | string | Original person identifier | - | - | - |
| pidebdk | boolean | Person ID enriched by driver key | - | - | - |
| phnid | string | Person hierarchy node identifier | - | - | - |
| php | string | Person hierarchy path | - | - | - |
| ar | string | Asset registration | - | - | - |
| ahnid | string | Asset hierarchy node identifier | - | - | - |
| ahp | string | Asset hierarchy path | - | - | - |
| ahnn | string | Asset hierarchy node name | - | - | - |
| aslk | number | Asset speed limit in kph | - | format (float) | - |
| dd | number | Direction in degrees | - | format (float) | - |
| sk | number | Speed in kph | - | format (float) | - |
| ds | integer | Duration in seconds | - | format (int64) | - |
| dkms | number | Distance in kilometers | - | format (double) | - |
| tripKm | number | Cumulative journey distance in km | - | format (double) | - |
| sid | integer | Sequence identifier | - | format (int64) | - |
| pri | boolean | Whether the location is private | - | - | - |
| hj | boolean | Whether to hide journey | - | - | - |
| syn | boolean | Whether the event is synthetic (generated missing start or end of journey event) | - | - | - |
| cti | integer | Created time in epoch milliseconds | - | format (int64) | - |
| lmt | integer | Last modified time in epoch milliseconds | - | format (int64) | - |
| ot | string | Odometer type | allowed ("GPS", "CAN") | - | - |
| coord.long | number | Coordinate longitude | - | format (double) | - |
| coord.lat | number | Coordinate latitude | - | format (double) | - |
| ad.fa | string | Formatted address | - | - | - |
| ad.rd | string | Road name | - | - | - |
| ad.rn | string | Road number | - | - | - |
| ad.cty | string | City | - | - | - |
| ad.pc | string | Postcode | - | - | - |
| ad.ctry | string | Country | - | - | - |
| ad.rsk | number | Road speed limit in kph | - | format (float) | - |
| ad.rt | string | Road type | - | - | - |
| ad.slt | integer | Speed limit type | - | - | - |
| ad.cic | string | Country ISO code | - | - | - |
| ad.dv | string | Division | - | - | - |
| ad.sdv | string | Subdivision | - | - | - |
| ad.dvic | string | Division ISO code | - | - | - |
| ad.sdvic | string | Subdivision ISO code | - | - | - |
| carc | integer | Cumulative asset runtime in seconds | - | format (int64) | - |
| capts | integer | Cumulative asset PTO time in seconds | - | format (int64) | - |
| caits | integer | Cumulative asset idle time in seconds | - | format (int64) | - |
| cafu | number | Cumulative asset fuel used | - | format (double) | - |
| cadkm | number | Cumulative asset distance in km | - | format (double) | - |
| fcl | number | Fuel cumulative liters (journey) | - | format (double) | - |
| cty | string | Cost type (section) | - | - | - |
| co | number | Cost value | - | format (double) | - |
| cc | string | Cost currency | - | - | - |
| bl | number | Battery level | - | format (float) | - |
| ath | number | Asset total hours | - | format (float) | - |
| eth | number | Engine total hours | - | format (float) | - |
| erpm | number | Engine RPM | - | format (float) | - |
| fll | number | Fuel level in litres | - | format (float) | - |
| flp | number | Fuel level percentage | - | format (float) | - |
| evrk | number | EV range in km | - | format (float) | - |
| evrke | boolean | EV range km is estimated | - | - | - |
| evsocp | number | EV state of charge percentage | - | format (float) | - |
| evsocpe | boolean | EV state of charge percentage is estimated | - | - | - |
| ecrm | number | EV charge remaining minutes | - | format (float) | - |
| ecm | string | EV charging mode | - | - | - |
| is | string | Ignition status | - | - | - |
| bv | number | Battery voltage | - | format (float) | - |
| epv | number | External power voltage | - | format (float) | - |
| ps | string | Power source | - | - | - |
| emv | number | Event max value (behaviour alert) | - | format (float) | - |
| eds | integer | Event duration in milliseconds | - | format (int64) | - |
| pl | array<object> | Places | - | - | - |
| pl.id | string | Place identifier | - | - | - |
| pl.nm | string | Place name | - | - | - |
| pl.plcid | string | Place category identifier | - | - | - |
| pl.plcnm | string | Place category name | - | - | - |
| in.id | string | Input identifier | - | - | - |
| in.tm | integer | Input time | - | format (int64) | - |
| in.ty | string | Input type | - | - | - |
| in.v | string | Input value | - | - | - |
| ins | array<object> | Multiple inputs | - | - | - |
| ins.id | string | Input identifier | - | - | - |
| ins.tm | integer | Input time | - | format (int64) | - |
| ins.ty | string | Input type | - | - | - |
| ins.v | string | Input value | - | - | - |
| iet | string | Input event type | - | - | - |
| ch | array<object> | Input channels | - | - | - |
| ch.chit | string | Channel input type | - | - | - |
| ch.chiv | string | Channel input value | - | - | - |
| ch.chicv | string | Channel input calculated value | - | - | - |
| ch.chilut | integer | Channel input last updated time | - | format (int64) | - |
| ch.chicat | string | Channel input category | - | - | - |
| ch.chisnp | string | Channel input serial number probe | - | - | - |
| dfs | array<object> | Device defects | - | - | - |
| dfs.dfty | string | Defect type | - | - | - |
| dfs.dfco | string | Defect code | - | - | - |
| dfs.dfst | string | Defect status | - | - | - |
| dfs.dfedt | integer | Defect event date time | - | format (int64) | - |
| dfs.dfde | string | Defect details | - | - | - |
| enrg | object | Energy data | - | - | additional properties are allowed |
| pft | string | Primary fuel type | - | - | - |
| pfc | number | Primary fuel capacity | - | format (double) | - |
| pac | number | Primary average consumption | - | format (double) | - |
| parkm | number | Primary average range in km | - | format (double) | - |
| sft | string | Secondary fuel type | - | - | - |
| sfc | number | Secondary fuel capacity | - | format (double) | - |
| sac | number | Secondary average consumption | - | format (double) | - |
| sarkm | number | Secondary average range in km | - | format (double) | - |
| tags | array<string> | Tags | - | - | - |
| tags (single item) | string | - | - | - | - |
| aft | array<string> | Asset feature tags | - | - | - |
| aft (single item) | string | - | - | - | - |
| ipids | array<string> | Interested parties IDs | - | - | - |
| ipids (single item) | string | - | - | - | - |
| iptags | array<string> | Interested parties tags | - | - | - |
| iptags (single item) | string | - | - | - | - |
| bt | array<string> | Box types | - | - | - |
| bt (single item) | string | - | - | - | - |
| psr | object | Periodic sample raw data | - | - | additional properties are allowed |
| dim | boolean | Device is mirror | - | - | - |
| lan | string | Linked asset name | - | - | - |
| laid | string | Linked asset identifier | - | - | - |
| lar | string | Linked asset registration | - | - | - |
| deid | string | Driver external identifier | - | - | - |
| ta.td | integer | Tachograph time date | - | format (int64) | - |
| ta.vid | string | Tachograph vehicle ID number | - | - | - |
| ta.vrn | string | Tachograph vehicle registration number | - | - | - |
| ta.hrtvd | integer | Tachograph high resolution total vehicle distance | - | - | - |
| ta.mv | string | Tachograph make version | - | - | - |
| ta.ims | string | Tachograph issuing member state | - | - | - |
| ta.cdid | string | Tachograph current driver ID | - | - | - |
| ta.ca | string | Tachograph current activity | - | - | - |
| ta.lto | integer | Tachograph local time offset | - | - | - |
| ta.oosc | string | Tachograph out of scope condition | - | - | - |
| ta.cdn | string | Tachograph current driver name | - | - | - |
| ta.catts | integer | Tachograph current activity total time in seconds | - | format (int64) | - |
| ta.trs | string | Tachograph time related states | - | - | - |
| ta.cdts | integer | Tachograph continuous driving time in seconds | - | format (int64) | - |
| ta.ddts | integer | Tachograph daily driving time in seconds | - | format (int64) | - |
| ta.wdts | integer | Tachograph weekly driving time in seconds | - | format (int64) | - |
| ta.pctdts | integer | Tachograph previous and current total drive time in seconds | - | format (int64) | - |
| ta.rdts | integer | Tachograph remaining driving time in seconds | - | format (int64) | - |
| ta.rddts | integer | Tachograph remaining daily driving time in seconds | - | format (int64) | - |
| ta.rwdts | integer | Tachograph remaining weekly driving time in seconds | - | format (int64) | - |
| ta.tlundrs | integer | Time left until next daily rest in seconds | - | format (int64) | - |
| ta.ndrmds | integer | Next daily rest min duration in seconds | - | format (int64) | - |
| ta.tlunwrs | integer | Time left until next weekly rest in seconds | - | format (int64) | - |
| ta.nwrmds | integer | Next weekly rest min duration in seconds | - | format (int64) | - |
| ta.ldre | integer | Last daily rest end | - | format (int64) | - |
| ta.lwre | integer | Last weekly rest end | - | format (int64) | - |
| ta.rdedtp | integer | Remaining daily extended drive time periods | - | - | - |
| ta.rdsrtp | integer | Remaining daily shortened rest time periods | - | - | - |
| ta.wtslbs | integer | Working time since last break in seconds | - | format (int64) | - |
| ta.rwts | integer | Remaining working time in seconds | - | format (int64) | - |
| ta.dwts | integer | Daily working time in seconds | - | format (int64) | - |
| ta.rdwts | integer | Remaining daily working time in seconds | - | format (int64) | - |
| ta.wwts | integer | Weekly working time in seconds | - | format (int64) | - |
| ta.rwwts | integer | Remaining weekly working time in seconds | - | format (int64) | - |
| ta.dbts | integer | Daily break time in seconds | - | format (int64) | - |
| ta.dp | string | Driving prediction | - | - | - |
| ta.wp | string | Working prediction | - | - | - |
| ta.dced | integer | Driver card expiry date | - | format (int64) | - |
| ta.dcnmdd | integer | Driver card next mandatory download date | - | format (int64) | - |
| ta.tlunrps | integer | Time left until next rest period in seconds | - | format (int64) | - |
| ta.nrds | integer | Next rest duration in seconds | - | format (int64) | - |
| ta.dci | boolean | Driver card inserted | - | - | - |
| ta.vis | string | Vehicle ignition state | - | - | - |
| ta.vs | integer | Vehicle speed | - | - | - |
| ta.es | integer | Engine speed | - | - | - |
| ta.rcpws | integer | Rest compensation previous week in seconds | - | format (int64) | - |
| ta.rcspws | integer | Rest compensation second previous week in seconds | - | format (int64) | - |
| ta.rctpws | integer | Rest compensation third previous week in seconds | - | format (int64) | - |
| ta.rtocrs | integer | Remaining time of current rest in seconds | - | format (int64) | - |
| ta.docrs | integer | Duration of current rest in seconds | - | format (int64) | - |
| ta.tut | string | Times update type | - | - | - |
| ta.ds | string | Driver slot | - | - | - |
| ta.rms | string | Registration member state | - | - | - |
| ta.odid | string | Other driver ID | - | - | - |
| ta.oims | string | Other driver issuing member state | - | - | - |
| tpms.t | string | TPMS type | - | - | - |
| tpms.dp | string | TPMS device position | - | - | - |
| tpms.rec | object | TPMS receiver information | - | - | additional properties are allowed |
| tpms.rec.mac | string | MAC address | - | - | - |
| tpms.rec.lrt | integer | Last received time | - | format (int64) | - |
| tpms.reps | array<object> | TPMS repeaters | - | - | - |
| tpms.reps.mac | string | MAC address | - | - | - |
| tpms.reps.lrt | integer | Last received time | - | format (int64) | - |
| tpms.sens | array<object> | TPMS sensors | - | - | - |
| tpms.sens.i | integer | Sensor index | - | - | - |
| tpms.sens.s | string | Sensor status | - | - | - |
| tpms.sens.mac | string | MAC address | - | - | - |
| tpms.sens.p | string | Position | - | - | - |
| tpms.sens.a | integer | Axle number | - | - | - |
| tpms.sens.as | string | Axle side | - | - | - |
| tpms.sens.wp | string | Wheel position | - | - | - |
| tpms.sens.ppa | number | Pressure in Pa | - | - | - |
| tpms.sens.tc | number | Temperature in °C | - | - | - |
| tpms.sens.ls | string | Location status | - | - | - |
| tpms.sens.lrt | integer | Last received time | - | format (int64) | - |
| ebs.aatgt | integer | EBS ABS active towing transitions | - | - | - |
| ebs.blt | integer | EBS brake light transitions | - | - | - |
| ebs.sbdmin | number | EBS service brake demand min Pa | - | - | - |
| ebs.sbdmax | number | EBS service brake demand max Pa | - | - | - |
| ebs.sbdmean | number | EBS service brake demand mean Pa | - | - | - |
| ebs.vatgt | integer | EBS VDC active towing transitions | - | - | - |
| ebs.rst | integer | EBS ROP system transitions | - | - | - |
| ebs.yst | integer | EBS YC system transitions | - | - | - |
| ebs.aot | integer | EBS ABS off road transitions | - | - | - |
| ebs.wbstgmin | number | EBS wheel based speed towing min m/s | - | - | - |
| ebs.wbstgmax | number | EBS wheel based speed towing max m/s | - | - | - |
| ebs.wbstgmean | number | EBS wheel based speed towing mean m/s | - | - | - |
| ebs.aatdt | integer | EBS ABS active towed transitions | - | - | - |
| ebs.sbt | integer | EBS service brake transitions | - | - | - |
| ebs.atvbt | integer | EBS auto towed vehicle brake transitions | - | - | - |
| ebs.vatdt | integer | EBS VDC active towed transitions | - | - | - |
| ebs.lamin | number | EBS lateral acceleration min m/s² | - | - | - |
| ebs.lamax | number | EBS lateral acceleration max m/s² | - | - | - |
| ebs.lamean | number | EBS lateral acceleration mean m/s² | - | - | - |
| ebs.wbstdmin | number | EBS wheel based speed towed min m/s | - | - | - |
| ebs.wbstdmax | number | EBS wheel based speed towed max m/s | - | - | - |
| ebs.wbstdmean | number | EBS wheel based speed towed mean m/s | - | - | - |
| ebs.alsmin | integer | EBS axle load sum min kg | - | format (int64) | - |
| ebs.alsmax | integer | EBS axle load sum max kg | - | format (int64) | - |
| ebs.alsmean | integer | EBS axle load sum mean kg | - | format (int64) | - |
| ebs.vest | integer | EBS vehicle electrical supply transitions | - | - | - |
| ebs.rwst | integer | EBS red warning signal transitions | - | - | - |
| ebs.awst | integer | EBS amber warning signal transitions | - | - | - |
| ebs.lrt | integer | EBS loading ramp transitions | - | - | - |
| ebs.slbt | integer | EBS supply line braking transitions | - | - | - |
| ebs.blgt | integer | EBS brake lining transitions | - | - | - |
| ebs.btst | integer | EBS brake temperature status transitions | - | - | - |
| ebs.vpst | integer | EBS vehicle pneumatic supply transitions | - | - | - |
| ebs.blmin | integer | EBS brake lining min percentage | - | format (int64) | - |
| ebs.blmax | integer | EBS brake lining max percentage | - | format (int64) | - |
| ebs.blmean | integer | EBS brake lining mean percentage | - | format (int64) | - |
| ebs.btmin | integer | EBS brake temperature min °C | - | format (int64) | - |
| ebs.btmax | integer | EBS brake temperature max °C | - | format (int64) | - |
| ebs.btmean | integer | EBS brake temperature mean °C | - | format (int64) | - |
| ebs.psmin | integer | EBS pneumatic supply min Pa | - | format (int64) | - |
| ebs.psmax | integer | EBS pneumatic supply max Pa | - | format (int64) | - |
| ebs.rlap1 | integer | EBS RGE21 lift axle position 1 | - | format (int64) | - |
| ebs.rlap2 | integer | EBS RGE21 lift axle position 2 | - | format (int64) | - |
| ebs.vvd | number | EBS VHDR vehicle distance in meters | - | - | - |
Examples of payload (generated)
{
"id": "string",
"cid": "string",
"esn": "string",
"aid": "string",
"an": "string",
"amk": "string",
"amd": "string",
"at": "string",
"edt": 0,
"ngps": 0,
"hdop": 0.1,
"eca": 0,
"eco": 0,
"es": "string",
"dk": "string",
"pid": "string",
"pn": "string",
"opid": "string",
"pidebdk": true,
"phnid": "string",
"php": "string",
"ar": "string",
"ahnid": "string",
"ahp": "string",
"ahnn": "string",
"aslk": 0.1,
"dd": 0.1,
"sk": 0.1,
"ds": 0,
"dkms": 0.1,
"tripKm": 0.1,
"sid": 0,
"pri": true,
"hj": true,
"syn": true,
"cti": 0,
"lmt": 0,
"ot": "GPS",
"coord.long": 0.1,
"coord.lat": 0.1,
"ad.fa": "string",
"ad.rd": "string",
"ad.rn": "string",
"ad.cty": "string",
"ad.pc": "string",
"ad.ctry": "string",
"ad.rsk": 0.1,
"ad.rt": "string",
"ad.slt": 0,
"ad.cic": "string",
"ad.dv": "string",
"ad.sdv": "string",
"ad.dvic": "string",
"ad.sdvic": "string",
"carc": 0,
"capts": 0,
"caits": 0,
"cafu": 0.1,
"cadkm": 0.1,
"fcl": 0.1,
"cty": "string",
"co": 0.1,
"cc": "string",
"bl": 0.1,
"ath": 0.1,
"eth": 0.1,
"erpm": 0.1,
"fll": 0.1,
"flp": 0.1,
"evrk": 0.1,
"evrke": true,
"evsocp": 0.1,
"evsocpe": true,
"ecrm": 0.1,
"ecm": "string",
"is": "string",
"bv": 0.1,
"epv": 0.1,
"ps": "string",
"emv": 0.1,
"eds": 0,
"pl": [
{
"id": "string",
"nm": "string",
"plcid": "string",
"plcnm": "string"
}
],
"in.id": "string",
"in.tm": 0,
"in.ty": "string",
"in.v": "string",
"ins": [
{
"id": "string",
"tm": 0,
"ty": "string",
"v": "string"
}
],
"iet": "string",
"ch": [
{
"chit": "string",
"chiv": "string",
"chicv": "string",
"chilut": 0,
"chicat": "string",
"chisnp": "string"
}
],
"dfs": [
{
"dfty": "string",
"dfco": "string",
"dfst": "string",
"dfedt": 0,
"dfde": "string"
}
],
"enrg": {},
"pft": "string",
"pfc": 0.1,
"pac": 0.1,
"parkm": 0.1,
"sft": "string",
"sfc": 0.1,
"sac": 0.1,
"sarkm": 0.1,
"tags": [
"string"
],
"aft": [
"string"
],
"ipids": [
"string"
],
"iptags": [
"string"
],
"bt": [
"string"
],
"psr": {},
"dim": true,
"lan": "string",
"laid": "string",
"lar": "string",
"deid": "string",
"ta.td": 0,
"ta.vid": "string",
"ta.vrn": "string",
"ta.hrtvd": 0,
"ta.mv": "string",
"ta.ims": "string",
"ta.cdid": "string",
"ta.ca": "string",
"ta.lto": 0,
"ta.oosc": "string",
"ta.cdn": "string",
"ta.catts": 0,
"ta.trs": "string",
"ta.cdts": 0,
"ta.ddts": 0,
"ta.wdts": 0,
"ta.pctdts": 0,
"ta.rdts": 0,
"ta.rddts": 0,
"ta.rwdts": 0,
"ta.tlundrs": 0,
"ta.ndrmds": 0,
"ta.tlunwrs": 0,
"ta.nwrmds": 0,
"ta.ldre": 0,
"ta.lwre": 0,
"ta.rdedtp": 0,
"ta.rdsrtp": 0,
"ta.wtslbs": 0,
"ta.rwts": 0,
"ta.dwts": 0,
"ta.rdwts": 0,
"ta.wwts": 0,
"ta.rwwts": 0,
"ta.dbts": 0,
"ta.dp": "string",
"ta.wp": "string",
"ta.dced": 0,
"ta.dcnmdd": 0,
"ta.tlunrps": 0,
"ta.nrds": 0,
"ta.dci": true,
"ta.vis": "string",
"ta.vs": 0,
"ta.es": 0,
"ta.rcpws": 0,
"ta.rcspws": 0,
"ta.rctpws": 0,
"ta.rtocrs": 0,
"ta.docrs": 0,
"ta.tut": "string",
"ta.ds": "string",
"ta.rms": "string",
"ta.odid": "string",
"ta.oims": "string",
"tpms.t": "string",
"tpms.dp": "string",
"tpms.rec": {
"mac": "string",
"lrt": 0
},
"tpms.reps": [
{
"mac": "string",
"lrt": 0
}
],
"tpms.sens": [
{
"i": 0,
"s": "string",
"mac": "string",
"p": "string",
"a": 0,
"as": "string",
"wp": "string",
"ppa": 0,
"tc": 0,
"ls": "string",
"lrt": 0
}
],
"ebs.aatgt": 0,
"ebs.blt": 0,
"ebs.sbdmin": 0,
"ebs.sbdmax": 0,
"ebs.sbdmean": 0,
"ebs.vatgt": 0,
"ebs.rst": 0,
"ebs.yst": 0,
"ebs.aot": 0,
"ebs.wbstgmin": 0,
"ebs.wbstgmax": 0,
"ebs.wbstgmean": 0,
"ebs.aatdt": 0,
"ebs.sbt": 0,
"ebs.atvbt": 0,
"ebs.vatdt": 0,
"ebs.lamin": 0,
"ebs.lamax": 0,
"ebs.lamean": 0,
"ebs.wbstdmin": 0,
"ebs.wbstdmax": 0,
"ebs.wbstdmean": 0,
"ebs.alsmin": 0,
"ebs.alsmax": 0,
"ebs.alsmean": 0,
"ebs.vest": 0,
"ebs.rwst": 0,
"ebs.awst": 0,
"ebs.lrt": 0,
"ebs.slbt": 0,
"ebs.blgt": 0,
"ebs.btst": 0,
"ebs.vpst": 0,
"ebs.blmin": 0,
"ebs.blmax": 0,
"ebs.blmean": 0,
"ebs.btmin": 0,
"ebs.btmax": 0,
"ebs.btmean": 0,
"ebs.psmin": 0,
"ebs.psmax": 0,
"ebs.rlap1": 0,
"ebs.rlap2": 0,
"ebs.vvd": 0
}