Productivity Report

Task productivity metrics per vehicle/driver — task counts, hours, kilometers, and occupancy.

GET/apidev/v1/reports/gt/productivity

PermissionAPICLI_RPTGT_PRODUCTIVIDAD

Rate Limit10 req/min

Cache300s

Max Range31 days

---

Request

Query Parameters

Parameter	Type	Required	Default	Description
startdate	string	Yes	—	ISO 8601 start date-time (e.g. 2026-03-01T00:00:00).
enddate	string	Yes	—	ISO 8601 end date-time. Max range 31 days from startdate.
devices	string	No	—	Comma-separated device IDs. Max 500.
drivers	string	No	—	Comma-separated driver IDs. Max 500.
device_groups	string	No	—	Comma-separated device group IDs. Max 100.
service_types	string	No	—	Comma-separated service type IDs. Max 100.
group_by_person	boolean	No	false	Group results by driver instead of device.
limit	integer	No	25	Number of records per page (1–100).
offset	integer	No	0	Number of records to skip for pagination.

---

Code Examples

cURL

curl -s -H "Authorization: Bearer $TOKEN" \
  -H "X-API-Key: $APIKEY" \
  -H "tenant: $TENANT" \
  "https://$TENANT/apidev/v1/reports/gt/productivity?startdate=2026-03-01T00:00:00&enddate=2026-03-15T23:59:59&limit=25"

JavaScript

const res = await fetch(
  `https://${TENANT}/apidev/v1/reports/gt/productivity?startdate=2026-03-01T00:00:00&enddate=2026-03-15T23:59:59&limit=25`,
  {
    headers: {
      'Authorization': `Bearer ${TOKEN}`,
      'X-API-Key': APIKEY,
      'tenant': TENANT,
    },
  }
);
const data = await res.json();

Python

import requests

response = requests.get(
    f"https://{TENANT}/apidev/v1/reports/gt/productivity",
    headers={"Authorization": f"Bearer {TOKEN}", "X-API-Key": APIKEY, "tenant": TENANT},
    params={"startdate": "2026-03-01T00:00:00", "enddate": "2026-03-15T23:59:59", "limit": 25},
)
data = response.json()

---

Response

Response Fields

Field	Type	Description
service_type	string	Service type name.
driver_name	string	Driver name.
device_name	string	Vehicle name.
unscheduled_tasks	number	Count of unscheduled tasks.
scheduled_tasks	number	Count of scheduled tasks.
total_tasks	number	Total task count.
task_hours	number	Hours spent on tasks.
shift_hours	number	Total shift hours.
kms_worked	number	Kilometers during tasks.
kms_ideal	number	Ideal/planned kilometers.
kms_shift	number	Total shift kilometers.
avg_arrival_time	number	Average arrival time (seconds).
occupancy	number	Occupancy rate percentage.

Example Response

{
  "success": true,
  "data": [
    {
      "service_type": "Maintenance",
      "driver_name": "Carlos Martinez",
      "device_name": "Truck A-101",
      "unscheduled_tasks": 3,
      "scheduled_tasks": 12,
      "total_tasks": 15,
      "task_hours": 6.5,
      "shift_hours": 8.0,
      "kms_worked": 142.3,
      "kms_ideal": 135.0,
      "kms_shift": 180.0,
      "avg_arrival_time": 1842,
      "occupancy": 81.25
    }
  ],
  "meta": {
    "total": 1,
    "limit": 25,
    "offset": 0
  }
}

---

Errors

Code	HTTP	Description
BAD_REQUEST	400	Missing required headers.
VALIDATION_ERROR	400	Invalid params: missing dates, range > 31 days, invalid enum values.
UNAUTHORIZED	401	Invalid or expired JWT / API Key.
FORBIDDEN	403	User lacks required permission.
RATE_LIMITED	429	Exceeded 10 req/min.
INTERNAL_ERROR	500	Unexpected server error.

---

Related

• Tasks General Report
• Proactivity by Device Report
• Proactivity by Task Report
• Pagination