Skip to main content

Detailed Report

Contents

The Detailed Report provides a comprehensive report for each leg of the route.

Parameters

With your API key, you can try a Detailed Report request using the form below. The required parameters are marked with an asterisk. You can enter values for any of the optional parameters by first checking the box next to them. Scroll down the page to submit your request.

Detailed Report Request

API KEY
GET

Response

Detailed Report Response

NameDescriptionData TypeValue/Example
typeDescribes the type of report and what it does.
string
DetailReport
RouteIDThe route identification key(Can be null)
Int
OriginWhere the route started from
Complex
NameDescriptionData 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
NameDescriptionData TypeValue/Example
Originwhere the route started from.
Complex
See origin row above.
ReportLinesGives us the details as to to time, miles and direction travelled on a route.
Complex
DestWhere the route ends at.
Complex
See origin row above.

Address

The fields below are returned as part of an Address object, which describes a location on your route. Not all fields will be populated in the response. Some fields depend on settings in the report request.

NameDescriptionData TypeValue/Example
TimeZoneThe location’s time zone.
Enum
See a full list of supported time zones.
SPLCThe location’s nine-digit Standard Point Location Code (SPLC), if one exists, to use in place of street/city/state/zip. SPLCs are maintained by the National Motor Freight Traffic Association Inc. and require special licensing for use in Trimble Maps data.
String
171735301
CountryPostalFilterThe postal code filter, which is used to filter ZIP codes by country.
Enum
0 - US
1 - Mexico
2 - Both
AbbreviationFormatThe abbreviation format for the country code. See the country code table. Also applies to states in Mexico.
Enum
0 - FIPS
1 - ISO2
2 - ISO3
3 - GENC2
4 - GENC3

ReportLines

The fields below are returned as part of a ReportLines object and provide detailed information about each leg of a route, including time, mileage, and direction of travel. A “leg” is a section of route between a pair of stops. (For example, for a two-stop route, there will be one leg between origin and destination. For a three-stop route, there will be two legs—one from the origin to stop 1 and then one from stop 1 to the destination.)

In a detailed report, a leg may have multiple ReportLines—one for each turn instruction within that leg.

Not all fields will be populated in the response. Some fields depend on settings in the report request.

NameDescriptionData Type
WarnA message string detailing any warnings related to that section (report line) of the route.
String
ARStateThe arrival state information such as “Arrive Loaded.”
String
StopA message string detailing stop information. Stops are identified as “Origin” (first stop); “Dest” (last stop); or numbered intermediate stops, (Stop 1, Stop 2, etc.).
String
StateThe two-letter state abbreviation.
String
DirectionThe driving direction for that section (report line) of the route.
String
MilesThe driving miles for that section (report line) of the route.
String
TimeThe driving time for that section (report line) of the route.
String
InterChA message string detailing exit or interchange information for that section (report line) of the route.
String
LMilesThe total driving miles for that leg at that point in the route.
String
LTimeThe total time elapsed for that leg at that point in the route.
String
TMilesThe total driving miles for the entire trip at that point in the route.
String
TTimeThe total time elapsed for the entire trip at that point in the route.
String
LTollThe toll cost for that leg at that point in the route.
String
TTollThe total toll cost for the entire trip at that point in the route.
String
TollPlazaAbbrAn abbreviation for the toll plaza.
String
TollPlazaNameThe full name of the toll plaza.
String
EtaEtdEstimated time of arrival or departure for that leg of the route. This field is only returned if estimated time options are included in the detailed report request.
String
InfoBreak and border wait information.
String
RestrictionHazmat restriction information.
String
StartCoordinateThe beginning GPS coordinates for that leg of the route.
String
EndCoordinateThe end GPS coordinates for that leg of the route.
String
Last updated August 31, 2023.
Contents