Telemetry Payload

The top-level payload submitted to both the single and batch telemetry endpoints.

Constraints

  • At least one of deviceIdentifier, assetIdentifier must be provided.
  • At least one of signals, gps must be provided.
  • If signals is provided, deviceIdentifier is required.
FieldTypeDescription
payloadId string required A UUID uniquely identifying this payload. Used for deduplication and error reporting. UUID
carrier string required The carrier's SCAC (Standard Carrier Alpha Code) identifying the logistics operator submitting this data.
deviceIdentifier DeviceIdentifier optional Identifies the physical telematics device that produced the data. The service uses this to look up the associated asset in the asset registry.
assetIdentifier AssetIdentifier optional Directly identifies the asset associated with this payload. Use when the asset's identity is already known without a device registry lookup.
signalTimestamp number required Epoch milliseconds timestamp of when the signal or GPS data was collected at the edge device.
edgeTimestamp number optional Epoch milliseconds timestamp of when the payload was transmitted from the edge device.
vendorTimestamp number optional Epoch milliseconds timestamp reported by the device vendor. Use when the vendor timestamp differs from the edge timestamp.
signals array of Signal optional List of telematics signal readings.
gps GPS optional GPS position, motion, and environmental data.