DistanceFuelByRegionSummary

The Distance & Fuel by Region Summary report XML response is invoked by external calls for the DistanceFuelByRegionSummary table.

This report offers a high-level overview regarding time spent, distance driven, and fuel used in each regionLarge-scale hotspots used to track fleet activity, such as at the state/province/city level. by driver or equipmentAll machines used as a means of production on a construction site or at a batch plant..

Measurements for distance and fuel are based on your company's Site Settings.

Parameters

distanceFuelByRegionParams

Parameter

Description

Type

Required

Notes

dateRange

The day(s) desired for report data querying.

Date Range

Required

 

employeeNums

The identification numbers for the employeeUser accounts for drivers, dispatchers, and other staff to perform varying functions in TrackIt.(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

employeeTypeIDs

The identification numbers for the employee type(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

vehicleNums

The identifying numbers for the vehicleAll machines used as a means of production on a construction site or at a batch plant.(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

vehicleTypeIDs

The identification numbers for the vehicle type(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

plantNums

The identifying numbers for the plantA production plant or material storage location.(s) queried.

String

Required

 Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

regionIDs

The identification numbers associated with the region(s) queried.

String

  

Required: Separate multiple entries with a comma.

allRegions

Forces all regions to be queried for the report.

Boolean

  

Options:

  • True queries all regions in TrackIt.
  • False queries only the region IDs provided.

sortByRegion

Groups all matching records by region.

Boolean

  

Options:

  • True sorts all entries by region.
  • False sorts all regions by the default method.

Returns

distanceFuelByRegionSummaryData
Parameter Description Notes
duration

Total time the vehicle spent in the region, as measured in minutes.

 
employeeFullName

The employee's first and last name.

 
employeeNum

The employee's identification number.

 
fuel

The total measurable quantity of fuel used within the region.

Engine Diagnostics licenses and configuration are required to report this.
gpsDistance

The distance driven within the region based on GPS calculations.

 
odoDistance

The distance driven within the region based on vehicle odometer readings.

Engine Diagnostics licenses and configuration are required to report this.
regionName

The name of the region where activity is reported.

 
vehicleName

The equipment's name.

 
vehicleNum

The equipment's identification number.