Devices and tracking

Reports

Reports generation

Fetch a combined route, Events and Positions report for the Devices or Groups

GET
https://demo.traccar.org/api/reports/combined

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json
Show child attributes
deviceIdinteger<int64>

Device identifier for the report item

routeArray<Array<number>>

Simplified route as [longitude, latitude] pairs

Show child attributes
idinteger<int64>

Unique event identifier

typestring

Event type name

eventTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceIdinteger<int64>

Device associated with the event

positionIdinteger<int64>

Position record linked to the event when applicable

geofenceIdinteger<int64>

Geofence referenced by the event if any

maintenanceIdinteger

Maintenance record tied to the event

attributesobject

Additional event-specific attributes

Show child attributes
idinteger<int64>

Unique position record identifier

deviceIdinteger<int64>

Identifier of the device that reported this position

protocolstring

Device protocol name that produced the message

deviceTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

fixTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

serverTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

validboolean

Indicates whether the position was marked as valid by the device

latitudenumber

Latitude in decimal degrees

longitudenumber

Longitude in decimal degrees

altitudenumber

Altitude above sea level in meters

speednumber

in knots

coursenumber

Heading in degrees (0-360) where 0 is true north

addressstring

Resolved reverse-geocoded address if available

accuracynumber

Estimated positional accuracy in meters when provided

networkobject

Network metadata (e.g. cell or Wi‑Fi data) supplied by the device

geofenceIdsArray<integer>

List of geofence ids applicable to this position

attributesobject

Custom key-value attributes sent by the device or enrichments

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Fetch a list of Positions within the time period for the Devices or Groups

GET
https://demo.traccar.org/api/reports/route

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Show child attributes
idinteger<int64>

Unique position record identifier

deviceIdinteger<int64>

Identifier of the device that reported this position

protocolstring

Device protocol name that produced the message

deviceTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

fixTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

serverTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

validboolean

Indicates whether the position was marked as valid by the device

latitudenumber

Latitude in decimal degrees

longitudenumber

Longitude in decimal degrees

altitudenumber

Altitude above sea level in meters

speednumber

in knots

coursenumber

Heading in degrees (0-360) where 0 is true north

addressstring

Resolved reverse-geocoded address if available

accuracynumber

Estimated positional accuracy in meters when provided

networkobject

Network metadata (e.g. cell or Wi‑Fi data) supplied by the device

geofenceIdsArray<integer>

List of geofence ids applicable to this position

attributesobject

Custom key-value attributes sent by the device or enrichments

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Download the route report as a spreadsheet or send it by email

GET
https://demo.traccar.org/api/reports/route/{type}

Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.

Parameters

typestringxlsxmailrequiredpath
deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

200OKstring<binary>

Spreadsheet attachment

Response fields application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string<binary>
204No Content

Report queued for email delivery

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Fetch a list of Events within the time period for the Devices or Groups

GET
https://demo.traccar.org/api/reports/events

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
typeArray<string>query

% can be used to return events of all types

fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Show child attributes
idinteger<int64>

Unique event identifier

typestring

Event type name

eventTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceIdinteger<int64>

Device associated with the event

positionIdinteger<int64>

Position record linked to the event when applicable

geofenceIdinteger<int64>

Geofence referenced by the event if any

maintenanceIdinteger

Maintenance record tied to the event

attributesobject

Additional event-specific attributes

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Download the events report as a spreadsheet or send it by email

GET
https://demo.traccar.org/api/reports/events/{type}

Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.

Parameters

typestringxlsxmailrequiredpath
deviceIdArray<integer>query
groupIdArray<integer>query
typeArray<string>query

Event types to include; % matches all

alarmArray<string>query

Alarm types to include

fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

200OKstring<binary>

Spreadsheet attachment

Response fields application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string<binary>
204No Content

Report queued for email delivery

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Fetch geofence enter/exit intervals within the time period for Devices or Groups

GET
https://demo.traccar.org/api/reports/geofences

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
geofenceIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json
Show child attributes
deviceIdinteger<int64>

Device identifier for the geofence interval

deviceNamestring

Human readable device name

geofenceIdinteger<int64>

Geofence identifier

startTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

endTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Fetch a list of ReportSummary within the time period for the Devices or Groups

GET
https://demo.traccar.org/api/reports/summary

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Show child attributes
deviceIdinteger<int64>

Device identifier for the summary row

deviceNamestring

Human readable device name

maxSpeednumber

in knots

averageSpeednumber

in knots

distancenumber

in meters

spentFuelnumber

in liters

engineHoursinteger

Engine hours accumulated for the report period

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Download the summary report as a spreadsheet or send it by email

GET
https://demo.traccar.org/api/reports/summary/{type}

Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.

Parameters

typestringxlsxmailrequiredpath
deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

dailybooleanquery

Aggregate values by day instead of the full period

Response

200OKstring<binary>

Spreadsheet attachment

Response fields application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string<binary>
204No Content

Report queued for email delivery

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Fetch a list of ReportTrips within the time period for the Devices or Groups

GET
https://demo.traccar.org/api/reports/trips

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Show child attributes
deviceIdinteger<int64>

Device identifier for the trip

deviceNamestring

Human readable device name

businessboolean

Business attribute from the trip's starting position. False if absent.

maxSpeednumber

in knots

averageSpeednumber

in knots

distancenumber

in meters

spentFuelnumber

in liters

durationinteger

Trip duration in seconds

startTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

startAddressstring

Address where the trip started

startLatnumber

Starting latitude in decimal degrees

startLonnumber

Starting longitude in decimal degrees

endTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

endAddressstring

Address where the trip ended

endLatnumber

Ending latitude in decimal degrees

endLonnumber

Ending longitude in decimal degrees

driverUniqueIdstring

Unique identifier of the driver assigned to the trip

driverNamestring

Name of the driver assigned to the trip

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Download the trips report as a spreadsheet or send it by email

GET
https://demo.traccar.org/api/reports/trips/{type}

Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.

Parameters

typestringxlsxmailrequiredpath
deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

200OKstring<binary>

Spreadsheet attachment

Response fields application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string<binary>
204No Content

Report queued for email delivery

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Fetch a list of ReportStops within the time period for the Devices or Groups

GET
https://demo.traccar.org/api/reports/stops

At least one deviceId or one groupId must be passed

Parameters

deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

OK

Response fields application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Show child attributes
deviceIdinteger<int64>

Device identifier for the stop

deviceNamestring

Human readable device name

durationinteger

Stop duration in seconds

startTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

addressstring

Address where the stop occurred

latnumber

Stop latitude in decimal degrees

lonnumber

Stop longitude in decimal degrees

endTimestring<date-time>

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

spentFuelnumber

in liters

engineHoursinteger

Engine hours accumulated during the stop

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Download the stops report as a spreadsheet or send it by email

GET
https://demo.traccar.org/api/reports/stops/{type}

Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.

Parameters

typestringxlsxmailrequiredpath
deviceIdArray<integer>query
groupIdArray<integer>query
fromstring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring<date-time>requiredquery

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

Response

200OKstring<binary>

Spreadsheet attachment

Response fields application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string<binary>
204No Content

Report queued for email delivery

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)

Download the devices report as a spreadsheet or send it by email

GET
https://demo.traccar.org/api/reports/devices/{type}

Use type=xlsx to download the report, type=mail to deliver it by email asynchronously.

Parameters

typestringxlsxmailrequiredpath

Response

200OKstring<binary>

Spreadsheet attachment

Response fields application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string<binary>
204No Content

Report queued for email delivery

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)
ApiKeyhttp (bearer)