- Endpoint: v1/freight_visibility/vehicle_locations
- Description: Retrieves the current locations of all vehicles that you have subscribed to.
- Use Case: Fleet Managers can use this endpoint to monitor all the vehicles for which they have subscribed. This provides real-time visibility of the vehicle helping in tracking and efficient route management.
- Endpoint: v1/freight_visibility/subscribe
- Description: Creates a subscription to start tracking the location of a specified vehicle or asset.
- Use Case: This endpoint allows the Fleet Managers to create a subscription for a vehicle for which they want to track. Use this for real-time monitoring, tracking and route planning.
- Endpoint: v1/freight_visibility/subscribe/{tracking_subscription_id}
- Description: Updates the duration or expiry time of an existing subscription using the subscription ID.
- Use Case: Fleet Managers can use this endpoint to continue the tracking of a particular vehicle extensively without any interruptions or subscription issues.
- Endpoint: v1/freight_visibility/subscribe/{tracking_subscription_id}
- Description: Cancels an active subscription for a specific vehicle or asset, stopping location tracking.
- Use Case: This endpoint allows the Fleet Managers to cancel the subscription for vehicles that no longer require the location tracking, This allows the company to reduce costs by effectively managing the subscriptions.
- Endpoint: v1/freight_visibility/companies
- Description: Returns a list of companies that have granted permission for their vehicles to be tracked.
- Use Case: This endpoint is useful for third-party logistic companies or other service providers who want to know which of the companies allow the tracking of the vehicles.
- Endpoint: v1/freight_visibility/company_associated
- Description: Verifies whether a specific carrier has provided consent for location tracking.
- Use Case: This endpoint allows the Fleet Managers to confirm the consent of the carrier, if they allow the tracking of the vehicle or not. This allows the company to be in compliance with carrier's policies and regulations.
- Endpoint: v1/freight_visibility/vehicle_association
- Description: Retrieves a list of vehicles near a specified location, based on proximity data.
- Use Case: This endpoint allows the Fleet Managers or Dispatchers to assign the nearest available vehicles to a new job. This reduces the travel time as well as optimizes the resource allocation.
- Endpoint: v2/freight_visibility/vehicle_association
- Description: This v2 endpoint fetches the vehicles based on a scoring system. The factors for the scoring system are: Vehicle Proximity, Hours or Service (HOS), and Vehicle Direction.
- Use Case: deal for fleet managers needing precise, updated proximity data to efficiently dispatch the closest vehicles to time-sensitive tasks.
- Endpoint: v1/freight_visibility/vehicle_subscriptions
- Description: Provides a list of all currently active vehicle location subscriptions, detailing which vehicles are being tracked.
- Use Case: Useful for monitoring which vehicles or assets have active tracking subscriptions, ensuring oversight and managing subscription renewals or cancellations.
- Endpoint: v1/freight_visibility/vehicle_locations/details
- Description: This endpoint is used to fetch the most recent location details of a vehicle, specifically for locations within the past 24 hours. It helps businesses track the movement of a vehicle, allowing them to assess its position, speed, and status within a recent timeframe.
- Use Case: The Fleet Manager needs to track the real-time location of a specific truck to ensure it's on schedule and within the planned route. By using this endpoint, Fleet Manager can fetch the vehicle's location data from the last 24 hours, enabling them to monitor its progress, make adjustments, or dispatch assistance if needed.
- Endpoint: v1/freight_visibility/asset_association
- Description: Retrieves location details for a specific vehicle over the past 24 hours.
- Use Case: Used for analyzing recent routes, stops, and travel patterns of a vehicle, helping managers verify route adherence or investigate issues in recent trips.
- Endpoint: v1/freight_visibility/asset_locations
- Description: Returns a list of company assets near a given location, based on proximity.
- Use Case: Fleet Managers use this to quickly locate the nearby assets, and allocate the same. This helps in improving the response times.