GPS

GPS position, motion, and environmental data.

Constraints

  • If horizontalAccuracy is provided, horizontalAccuracyUnits must also be provided.
  • If altitude is provided, altitudeUnits must also be provided.
  • If accelerometerX is provided, accelerometerUnits must also be provided.
  • If accelerometerY is provided, accelerometerUnits must also be provided.
  • If accelerometerZ is provided, accelerometerUnits must also be provided.
  • If speed is provided, speedUnits must also be provided.
FieldTypeDescription
latitude number (double) required Latitude in decimal degrees (WGS 84). ≥ -90.0 ≤ 90.0
longitude number (double) required Longitude in decimal degrees (WGS 84). ≥ -180.0 ≤ 180.0
horizontalAccuracy number (double) optional Horizontal position accuracy as a radius of uncertainty. requires horizontalAccuracyUnits
horizontalAccuracyUnits string optional Unit of the horizontalAccuracy field. enum: DistanceUnit
inMotion boolean optional Whether the asset was in motion at the time of this reading.
altitude number (double) optional Altitude above sea level. requires altitudeUnits
altitudeUnits string optional Unit of the altitude field. enum: DistanceUnit
accelerometerX number (double) optional Longitudinal acceleration (forward/backward) measured by the device accelerometer. requires accelerometerUnits
accelerometerY number (double) optional Lateral acceleration (left/right) measured by the device accelerometer. requires accelerometerUnits
accelerometerZ number (double) optional Vertical acceleration (up/down) measured by the device accelerometer. requires accelerometerUnits
accelerometerUnits string optional Unit for all three accelerometer fields. enum: AccelerationUnit
heading number (double) optional Direction of travel in degrees clockwise from true north (0-360).
satelliteCount number optional Number of GPS satellites used to compute this fix.
hdop number (double) optional Horizontal dilution of precision — a dimensionless indicator of GPS fix quality. Lower is better.
speed number (double) optional Speed of the asset at the time of this reading. requires speedUnits
speedUnits string optional Unit of the speed field. enum: VelocityUnit
eventType string optional The event that triggered this GPS reading. Common values: PERIODIC, ENGINE_START, ENGINE_STOP, IGNITION_ON, IGNITION_OFF.