Skip to content

Reports

Routes Report

Fetch a list of Positions within a given time period for specified Devices or Groups.

Endpoint:

GET /reports/route

Authorization:

  • Requires Basic Authentication (basicAuth)

Parameters:

Name In Type Required Description
deviceId query array[integer] No One or more device IDs
groupId query array[integer] No One or more group IDs
from query string (date-time) Yes Start time in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
to query string (date-time) Yes End time in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Description:

  • At least one deviceId or one groupId must be passed.

cURL Example:

curl -u username:password "https://tracker.acubegps.com/api/reports/route?deviceId=1&from=2024-01-01T00:00:00Z&to=2024-01-01T23:59:59Z"

Response:

  • 200 OK — Returns a JSON array of Position objects or XLSX file.

Events Report

Fetch a list of Events within a given time period for specified Devices or Groups.

Endpoint:

GET /reports/events

Authorization:

  • Requires Basic Authentication (basicAuth)

Parameters:

Name In Type Required Description
deviceId query array[integer] No One or more device IDs
groupId query array[integer] No One or more group IDs
type query array[string] No Event type(s); % can be used for all types
from query string (date-time) Yes Start time in ISO 8601 format
to query string (date-time) Yes End time in ISO 8601 format

Description:

  • At least one deviceId or one groupId must be passed.

cURL Example:

curl -u username:password "https://tracker.acubegps.com/api/reports/events?deviceId=1&type=%&from=2024-01-01T00:00:00Z&to=2024-01-01T23:59:59Z"

Response:

  • 200 OK — Returns a JSON array of Event objects or XLSX file.

Summary Report

Fetch a list of ReportSummary entries within a given time period for specified Devices or Groups.

Endpoint:

GET /reports/summary

Authorization:

  • Requires Basic Authentication (basicAuth)

Parameters:

Name In Type Required Description
deviceId query array[integer] No One or more device IDs
groupId query array[integer] No One or more group IDs
from query string (date-time) Yes Start time in ISO 8601 format
to query string (date-time) Yes End time in ISO 8601 format

Description:

  • At least one deviceId or one groupId must be passed.

cURL Example:

curl -u username:password "https://tracker.acubegps.com/api/reports/summary?groupId=2&from=2024-01-01T00:00:00Z&to=2024-01-01T23:59:59Z"

Response:

  • 200 OK — Returns a JSON array of ReportSummary objects or XLSX file.

Trips Report

Fetch a list of ReportTrips within a given time period for specified Devices or Groups.

Endpoint:

GET /reports/trips

Authorization:

  • Requires Basic Authentication (basicAuth)

Parameters:

Name In Type Required Description
deviceId query array[integer] No One or more device IDs
groupId query array[integer] No One or more group IDs
from query string (date-time) Yes Start time in ISO 8601 format
to query string (date-time) Yes End time in ISO 8601 format

Description:

  • At least one deviceId or one groupId must be passed.

cURL Example:

curl -u username:password "https://tracker.acubegps.com/api/reports/trips?deviceId=3&from=2024-01-01T00:00:00Z&to=2024-01-01T23:59:59Z"

Response:

  • 200 OK — Returns a JSON array of ReportTrips objects or XLSX file.

Stops Report

Fetch a list of ReportStops within a given time period for specified Devices or Groups.

Endpoint:

GET /reports/stops

Authorization:

  • Requires Basic Authentication (basicAuth)

Parameters:

Name In Type Required Description
deviceId query array[integer] No One or more device IDs
groupId query array[integer] No One or more group IDs
from query string (date-time) Yes Start time in ISO 8601 format
to query string (date-time) Yes End time in ISO 8601 format

Description:

  • At least one deviceId or one groupId must be passed.

cURL Example:

curl -u username:password "https://tracker.acubegps.com/api/reports/stops?groupId=4&from=2024-01-01T00:00:00Z&to=2024-01-01T23:59:59Z"

Response:

  • 200 OK — Returns a JSON array of ReportStops objects or XLSX file.