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 ElementDescriptionData TypeValue/Example
THoursWithSecondsflag to return THours to the seconds precision. HH:MM:SS
boolean

Mileage Request

API KEY
GET

Response

Mileage Report Response

Data ElementDescriptionData TypeValue/Example
typeDescribes the type of report and what it does.
string
MileageReport
RouteIDThe route identification key(Can be null)
int
ReportLinesIndicates the miles, time and cost for each stop on the route.
Complex

ReportLines

Data ElementDescriptionData TypeValue/Example
StopsDescribes the stops encountered on the route.
Complex
Data ElementDescriptionData TypeValue/ExampleNote
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
Not Applicable
PlaceNameThe place name which corresponds to custom place.
string
Not Applicable
ErrorsEncapsulated the details about the errors associated with the geocode locationList of Complex Objects
LMilesMiles spent on this leg of the route
string
TMilesIndicates the total miles for that specific route stop.
string
LCostMileCost Miles spent on this leg of the route
string
TCostMileTotal cost miles spent on the route
string
LHoursHours spent on this leg for the route
string
THoursTotal hours on the route
string
LTollsTolls on this leg for the route
string
TTollsTotal tolls on the route
string
LEstghgEstimated green house gas on this leg for the route
string
TEstghgTotal estimated green house gas on the route
string
EtaEtdEstimated time of arrival or departure
string

Address

Data ElementDescriptionData TypeValue/Example
StreetAddressThe house number and street name
string
495 Walker Road
CityThe name of the city
string
Endicott
StateThe two letter state abbreviation
string
NY
ZipThe postal code or zip
string
13760
CountyThe county or jurisdiction.
string
Broome
CountryThe name of the country
string
United States
SPLCThe Standard Point Location code to use in place of street/city/state/zip
string
CountryPostalFilterThe postal code filter; use this to filter zip codes by country
Enum
Us
Em
Both
AbbreviationFormatThe abbreviation format for the country code. This is not applicable for NA dataset
Enum
FIPS
ISO2
ISO3
CountryAbbreviationAbbreviated country code corresponding to requested format.
string

Coords

Data ElementDescriptionData TypeValue/Example
LatLatitude
string
42.12345
LonLongitude
string
-76.12345
Last updated June 24, 2020.