tracking_health field to the response schemas for both load tracking endpoints. The field indicates how far to trust the last_position reported for the vehicle carrying a load. The endpoint descriptions have been updated to explain this behaviour.
Minor Release: Backward-compatible addition. The
tracking_health field is new and required in the response schema; existing integrations that do not read it are unaffected.Schema Changes
tracking_health field on load tracking responses
tracking_health field on load tracking responses
Updated endpoints:After:Impact:
GET /v2/visibility/loads/trackingGET /v2/visibility/loads/{load_id}/tracking
tracking_health field alongside last_position. This field describes how far to trust the last reported position for the vehicle carrying the load.The endpoint descriptions have been updated to reflect this: “last_position is the last position that vehicle reported, and tracking_health says how far to trust it.”Before:tracking_healthis a new required field in the response schema for both endpoints- It applies to all load tracking responses regardless of whether the vehicle assignment is
declaredorinferred - Integrations that do not read
tracking_healthrequire no changes
Integration Notes
1
Read tracking_health alongside last_position
Use
tracking_health to understand the reliability of the position data returned for a load’s vehicle:2
No action required for existing integrations
The
tracking_health field is additive. If your integration does not read it, no changes are needed.Need Help?
API Reference
View complete endpoint documentation for the Visibility API
Contact Support
Questions about your integration? Our team is here to help