Fleet Freedom
Main Site
Overview
WebSocket
JavaScript
Behaviours
Provisioning
Pictures
Reports
Events
Return to site

Reports API Reference

version 4.9.3
© 2025 Trak iT Wireless Inc.

Report Parameters

Parameters for each ReportType
  Full History Tag Summary Place Summary Messaging Task Lifetime Attributes Regions
Required
  • startDate
  • endDate
  • startDate
  • endDate
  • tags
  • startDate
  • endDate
  • startDate
  • endDate
  • startDate
  • endDate
  • startDate
  • endDate
  • attributes
  • startDate
  • endDate
Optional
  • timeOfDay
  • timeOfDay
  • duration
  • prolonged
  • distance
  • rubicon
  • timeOfDay
  • duration
  • prolonged
  • distance
  • rubicon
  • timeOfDay
  • timeOfDay
  • timeOfDay
  • duration
  • prolonged
  • distance
  • rubicon
  • timeOfDay
  • duration
  • prolonged
  • distance
  • rubicon

JSON Format

All the other properties from ReportResult are also present.
Property Type Description
totals Array[ReportTotal] Each ReportTotal in the array represents the total of each of the targeted assets' summary and/or breakdown data.
summary object{string:Array} Each key in the dictionary is a string serialized Asset.id that was targeted by the report.
summary[asset.id] Array[ReportSummary}
Each summary instance has a beginning and ending, a duration, a distance, and a polyline of positions for the asset. The stateDetail represents some string used by the report runner.
  1. Tag Summary: stateDetail is a codified tag name.
  2. Place Summary: stateDetail is the Place.id in question.
  3. Task Lifetime: stateDetail is the Task.id in question.
  4. Attributes: stateDetail is the chosen AssetAttribute.
  5. Regions: stateDetail is a combination of ISO-3166 Country code, ISO-3166 Province/State code, or City name.
breakdown object{string:Array} Each key in the dictionary is a string serialized Asset.id that was targeted by the report.
breakdown[asset.id] Array[ReportBreakdown]
Each breakdown contains a specific event or asset state which was used to calculate the summary instances.
There are three kinds of ReportBreakdown classes:
  1. ReportBreakdown
  2. ReportBreakdownMessage
  3. ReportBreakdownTask

XLSX Format

Note: this binary format is meant to be an attachment to the HTTPS response.

HTML Format

Note: this format is used in the front-end of Fleet Freedom and is modified more often than the other formats.

Trak iT® Wireless and Fleet Freedom® are Trademarks of Trak iT® Wireless Inc.
All content contained within this site is the property of Trak iT® Wireless unless otherwise stated.