Comparison (LeastCost) Report

Contents

The Comparison (LeastCost) Report provides a detailed comparison of the distance, time and costs associated with multiple possible routes between an origin and a destination. The routes are generated by using combinations of Route Types (Practical, Shortest and Fastest) and whether or not to avoid tolls.

Parameters

This table includes the most frequently used parameters. Please see the Route Reports overview page for a full list. If you would like to test out this API, enter values in the table below and scroll down the page to submit your request. Required parameters are highlighted in yellow. Check the box next to any additional parameters you would like to set.

LeastCost Report Request

API KEY
GET

Response

Comparison Report

Data ElementDescriptionData TypeValue/Example
typeDescribes the type of report and what it does.
string
LeastCost
RouteIDThe route identification key(Can be null)
Int
OriginWhere the route started from
Complex
Data ElementDescriptionData TypeValue/Example
AddressEncapsulates the details about the location
Complex
CoordsEncapsulates the details about the longitude/latitude
Complex
RegionIndicates the region of the location
Enum
LabelThe label to be displayed on maps and reports in association with a stop
string
PlaceNameThe place name which corresponds to custom place.
string
ErrorsEncapsulated the details about the errors associated with the geocode locationList of Complex Objects
DestinationWhere the route ends at.
Complex
See Origin row above
ReportLinesReport details, including distance and cost.
Complex
Data ElementDescriptionData TypeValue/Example
LeastCostTripOptionsprovides the type of trip it will be and whether to avoid tolls or not.
string
Practical Tolls Allowed
RouteThe different available routes
string
Route 1
MilesThe miles that it will take on a specific route
double
0.2
CostThe cost on a specific route
double
0.25
HoursThe time it will take to travel on a specific routetime0:01
TollsThe amount of tolls one will experience on a specific route
double
0.00
LaborAmount of labor it will take on a specific route
double
0.00
Last updated June 24, 2020.