User Manual
Version 7.5
×

API to get report data

https://<address>/api/api.php?cmd=get_report
 
Required parameters table
Parameter
Type
Example
Description
cmd
string
get_report
Command to get report data
report_type
int
1
Type of report
start
int
1724623200
Start time of sampling (unixtimestamp)
stop
int
1724709600
Stop time of sampling (unixtimestamp)
veh_id
string
1234,5678
List of vehicles (agents ids) separated by commas
explode
int
1
Report data split by (1 - days, 2 - weeks, 3 - do not split)
group
int
1
Report data grouping by (1 - days, 2 - objects, 3 - zones, 4 - drivers, 5 - clients, 6 - groups, 7 - tags)
format
string
json
Report data answer (json, pdf, xls)
tz
string
Africa/Johannesburg
Report time zone (see API https://<address>/api/api.php?cmd=get_time_zones)
 
 
Optional parameters table
Parameter
Type
Example 
Description
drivers_id
string
1234,5678
List of drivers ids separated by commas
zones_id
string
1234,5678
List of zones ids separated by commas
fillings
int
1
Enable fillings
stales
int
1
Enable drains
speed
int
1
Enable speed
rashod
int
1
Enable expense
stops
int
1
Enable stops
run
int
1
Enable run
contr_time
int
30
Set control time
type
int
1
Mileage in details build type
tags
string
1234,5678
List of tags ids separated by commas
template
int
1234
Template id
outside_zones
int
1
Enable outside zones
work_hours
int
1
Enable work hours only
fuel
int
1
Enable fuel
vehicle_not_moving_time
int
30
Set vehicle not moving time
vehicles_has_covered_km
int
30
Set vehicles has covered km
notifications
string
1234,5678
List of notifications ids separated by commas