HotSpotTimeBreakdown

The Hotspot Time Breakdown report XML response is invoked by external calls for the HotspotTimeBreakdown table.

This report allows you to measure the amount of time spent within one or more hotspots.

Parameters

hotspotTimeParams

Parameter

Description

Type

Required

Notes

dateRange

The day(s) desired for report data querying.

Date Range

Required

 

employeeNum

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

Integer

 

 

vehicleNum

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

Integer

 

 

typeID

The employee or vehicle type ID depending on which one the query is focused.

Integer

 

 

hotspotIDs

The hotspotGeographic areas marked on a map that act as destinations for driver navigation or triggers for automated behaviors in TrackIt.'s identification number.

Integer

 

 

allPerm

Include results for hotspots marked as permanent.

Boolean

 

 

allNonPerm

Include results for hotspots not marked as permanent.

Boolean

 

 

sortByHotspot

Group all matching records by hotspot.

Boolean

 

 

Returns

hotspotTimeData
Parameter Description Notes

duration

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

 

durationMillis

Total time the vehicle spent in the regionLarge-scale hotspots used to track fleet activity, such as at the state/province/city level., as measured in milliseconds.

 

employeeNum

The employee's identification number.

 

enterExitTimes

The timestamps of when the equipmentAll machines used as a means of production on a construction site or at a batch plant. entered and exited the specific hotspot location.

 

hotspotID

The hotspot's identification number.

 

vehicleNum

The equipment's identification number.