Reports
Reports generation
Fetch a combined route, Events and Positions report for the Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Fetch a list of Positions within the time period for the Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Download the route report as a spreadsheet or send it by email
Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.
Parameters
typestringxlsxmailrequiredpathdeviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
Spreadsheet attachment
Report queued for email delivery
Unauthorized
Not found
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Fetch a list of Events within the time period for the Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>querytypeArray<string>query% can be used to return events of all types
fromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Download the events report as a spreadsheet or send it by email
Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.
Parameters
typestringxlsxmailrequiredpathdeviceIdArray<integer>querygroupIdArray<integer>querytypeArray<string>queryEvent types to include; % matches all
alarmArray<string>queryAlarm types to include
fromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
Spreadsheet attachment
Report queued for email delivery
Unauthorized
Not found
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Fetch geofence enter/exit intervals within the time period for Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>querygeofenceIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Fetch a list of ReportSummary within the time period for the Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Download the summary report as a spreadsheet or send it by email
Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.
Parameters
typestringxlsxmailrequiredpathdeviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
dailybooleanqueryAggregate values by day instead of the full period
Response
Spreadsheet attachment
Report queued for email delivery
Unauthorized
Not found
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Fetch a list of ReportTrips within the time period for the Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Download the trips report as a spreadsheet or send it by email
Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.
Parameters
typestringxlsxmailrequiredpathdeviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
Spreadsheet attachment
Report queued for email delivery
Unauthorized
Not found
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Fetch a list of ReportStops within the time period for the Devices or Groups
At least one deviceId or one groupId must be passed
Parameters
deviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
OK
Unauthorized
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Download the stops report as a spreadsheet or send it by email
Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.
Parameters
typestringxlsxmailrequiredpathdeviceIdArray<integer>querygroupIdArray<integer>queryfromstring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
tostring<date-time>requiredqueryin ISO 8601 format. eg. 1963-11-22T18:30:00Z
Response
Spreadsheet attachment
Report queued for email delivery
Unauthorized
Not found
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)Download the devices report as a spreadsheet or send it by email
Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.
Parameters
typestringxlsxmailrequiredpathResponse
Spreadsheet attachment
Report queued for email delivery
Unauthorized
Not found
Authorization
BasicAuthhttp (basic)ApiKeyhttp (bearer)