Directions Report

The Directions Report provides turn-by-turn directions for a route.

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.

Directions Report Specific Parameter

Data ElementDescriptionData TypeValue/Example
CondenseDirectionsIndicate whether or not to condense the driving directions within the report.
boolean

Directions Report Request

API KEY
GET

Response

Direction Report Response

Data ElementDescriptionData TypeValue/Example
typeDescribes the type of report and what it does.
string
DirectionReport
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
ReportLegsTurn by turn directions from origin.
Complex
Data ElementDescriptionData TypeValue/Example
Originwhere the route started from.
Complex
See origin row above.
ReportLinesGives us the directions and for the route we are taking to destination
Complex
DestWhere the route ends at.
Complex
See origin row above.