Models

Position

object

idinteger<int64>

Unique position record identifier

deviceIdinteger<int64>

Identifier of the device that reported this position

protocolstring

Device protocol name that produced the message

deviceTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

fixTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

serverTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

validboolean

Indicates whether the position was marked as valid by the device

latitudenumber

Latitude in decimal degrees

longitudenumber

Longitude in decimal degrees

altitudenumber

Altitude above sea level in meters

speednumber

in knots

coursenumber

Heading in degrees (0-360) where 0 is true north

addressstring

Resolved reverse-geocoded address if available

accuracynumber

Estimated positional accuracy in meters when provided

networkobject

Network metadata (e.g. cell or Wi‑Fi data) supplied by the device

geofenceIdsArray<integer>

List of geofence ids applicable to this position

attributesobject

Custom key-value attributes sent by the device or enrichments

Example

{
  "id": 0,
  "deviceId": 0,
  "protocol": "string",
  "deviceTime": "2024-01-15T09:30:00Z",
  "fixTime": "2024-01-15T09:30:00Z",
  "serverTime": "2024-01-15T09:30:00Z",
  "valid": true,
  "latitude": 0,
  "longitude": 0,
  "altitude": 0,
  "speed": 0,
  "course": 0,
  "address": "string",
  "accuracy": 0,
  "network": {},
  "geofenceIds": [
    0
  ],
  "attributes": {}
}

Docs by Sourcey