Skip to main content

RoutePath Report

The Route Path Report retrieves a series of geographic coordinates that make up a route. The route is generated using the parameters below.

Available for dataVersion 34 and Higher

Requires a license for access to Trimble Maps JavaScript.


With your API key, you can try a RoutePath Report request using the form below. The required parameters are marked with an asterisk. You can enter values for any of the optional parameters by first checking the box next to them. Scroll down the page to submit your request.

RoutePath Request



RoutePath Report Response

Data ElementDescriptionData Type
typeIndicates the type of response
geometryThe route points of the route that was runGeoJson Geometry
TMinutesThe trip’s total times in minutes.
TDistanceThe trip’s total distance in miles.
vehiclerestrictedcleanupgeometryList of coordinates that represents the path from the drivable road network to a stop located on a pedestrian only road. (This is usually the path the driver has walk to reach a stop on a vehicle-restricted road.) This path, if one exists, is only returned when includeVehicleRestrictedCleanupPoints is set to true in the request.GeoJson Geometry


Data ElementDescriptionData TypeValue/Example
TypeIndicates the type of geometry
Multistring (currently this is the only value)
CoordinatesA series of geographic coordinate points that make up a routeJson array of arrays
Last updated March 21, 2023.