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 Element Description Data Type Value/Example
CondenseDirections Indicate whether or not to condense the driving directions within the report.
boolean

Directions Report Request

API KEY
GET

Response

Direction Report Response

Data Element Description Data Type Value/Example
type Describes the type of report and what it does.
string
DirectionReport
RouteID The route identification key(Can be null)
Int
Origin Where the route started from
Complex
Data Element Description Data Type Value/Example
Address Encapsulates the details about the location
Complex
Coords Encapsulates the details about the longitude/latitude
Complex
Region Indicates the region of the location
Enum
Label The label to be displayed on maps and reports in association with a stop
string
PlaceName The place name which corresponds to custom place.
string
Errors Encapsulated the details about the errors associated with the geocode location List of Complex Objects
Destination Where the route ends at.
Complex
See Origin row above
ReportLegs Turn by turn directions from origin.
Complex
Data Element Description Data Type Value/Example
Origin where the route started from.
Complex
See origin row above.
ReportLines Gives us the directions and for the route we are taking to destination
Complex
Dest Where the route ends at.
Complex
See origin row above.