Skip to main content

Assignment Time Report

Time from task creation to driver assignment — average, min, and max per grouping.

GET/apidev/v1/reports/gt/assignment-time
PermissionAPICLI_RPTGT_TAS
Rate Limit10 req/min (sliding window)
Cache300s (5 min)
Max Range31 days

Query Parameters

ParameterTypeRequiredDefaultDescription
startdatestringYesISO 8601 start date-time
enddatestringYesISO 8601 end date-time. Max range 31 days
devicesstringNoAll visibleComma-separated device IDs. Max 500
driversstringNoAllComma-separated driver IDs. Max 500
service_typesstringNoAllComma-separated service type IDs. Max 100
causesstringNoAllComma-separated cause IDs. Max 100
subcausesstringNoAllComma-separated subcause IDs. Max 100
statusesstringNoAllComma-separated status codes. Max 100
device_groupsstringNoAllComma-separated device group IDs. Max 100
originsstringNoAllComma-separated origin IDs. Max 100
providersstringNoAllComma-separated provider IDs. Max 100
route_idsstringNoAllComma-separated route IDs. Max 100
operatorsstringNoAllComma-separated operator IDs. Max 100
client_idstringNoFilter by specific client
account_idstringNoFilter by specific account
shift_idstringNoFilter by specific shift
date_fieldenumNoDate field to filter on: CREATED, SCHEDULED, FINISHED
group_byenumNoGrouping dimension (see below)
limitintegerNo25Records per page (1100)
offsetintegerNo0Records to skip

group_by values

DATE · MONTH · HOUR · WEEKDAY · DEPARTMENT · CITY · ZONE · PROVIDER · DEVICE · DEVICE_GROUP · DRIVER · SHIFT · CAUSE · SUBCAUSE · END_CODE · ORIGIN · TELEPHONIST · OPERATOR


Code Examples

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

Response Fields

FieldTypeDescription
group_labelstringDisplay name of the group
group_idstring | nullIdentifier of the group element
total_tasksnumberTotal number of tasks
avg_assignment_secnumberAverage assignment time in seconds
min_assignment_secnumberMinimum assignment time in seconds
max_assignment_secnumberMaximum assignment time in seconds

Example Response

{
"success": true,
"data": [
{
"group_label": "Truck A-101",
"group_id": "104820579301",
"total_tasks": 47,
"avg_assignment_sec": 420,
"min_assignment_sec": 15,
"max_assignment_sec": 3600
},
{
"group_label": "Truck B-205",
"group_id": "104820579402",
"total_tasks": 32,
"avg_assignment_sec": 540,
"min_assignment_sec": 22,
"max_assignment_sec": 2800
}
],
"meta": {
"total": 2,
"limit": 25,
"offset": 0
}
}

Errors

CodeHTTPDescription
BAD_REQUEST400Missing required headers
VALIDATION_ERROR400Invalid params: missing dates, range > 31 days, invalid group_by
UNAUTHORIZED401Invalid or expired JWT / API Key
FORBIDDEN403User lacks required permission
RATE_LIMITED429Exceeded 10 req/min
INTERNAL_ERROR500Unexpected server error