Mileage Report

Contents

The Mileage Report provides the distance, time, and cost for each stop on a route. It can be set to retrieve distances in miles (default) or kilometers.

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.

Mileage Report Specific Parameter

Data Element Description Data Type Value/Example
THoursWithSeconds flag to return THours to the seconds precision. HH:MM:SS
boolean

Mileage Request

API KEY
GET

Response

Mileage Report Response

Data Element Description Data Type Value/Example
type Describes the type of report and what it does.
string
MileageReport
RouteID The route identification key(Can be null)
int
ReportLines Indicates the miles, time and cost for each stop on the route.
Complex

ReportLines

Data Element Description Data Type Value/Example
Stops Describes the stops encountered on the route.
Complex
Data Element Description Data Type Value/Example Note
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
Not Applicable
PlaceName The place name which corresponds to custom place.
string
Not Applicable
Errors Encapsulated the details about the errors associated with the geocode location List of Complex Objects
LMiles The distance for this leg of the route
string
TMiles The total distance at this point in the route
string
LCostMile The cost of this leg of the route, including tolls
string
TCostMile The total cost at this point in the route, including tolls
string
LHours The travel time in hours for this leg of the route
string
THours The total travel time in hours at this point in the route
string
LTolls The tolls for this leg of the route
string
TTolls The total tolls at this point in the route
string
LEstghg Estimated greenhouse gas emissions for this leg for the route
string
TEstghg The total estimated greenhouse gas emissions at this point in the route
string
EtaEtd Estimated time of arrival or departure
string

Address

Data Element Description Data Type Value/Example
StreetAddress The house number and street name
string
495 Walker Road
City The name of the city
string
Endicott
State The two letter state abbreviation
string
NY
Zip The postal code or zip
string
13760
County The county or jurisdiction.
string
Broome
Country The name of the country
string
United States
SPLC The Standard Point Location code to use in place of street/city/state/zip
string
CountryPostalFilter The postal code filter; use this to filter zip codes by country
Enum
Us
Em
Both
AbbreviationFormat The abbreviation format for the country code. This is not applicable for NA dataset
Enum
FIPS
ISO2
ISO3
CountryAbbreviation Abbreviated country code corresponding to requested format.
string

Coords

Data Element Description Data Type Value/Example
Lat Latitude
string
42.12345
Lon Longitude
string
-76.12345
Last updated October 22, 2020.