Get the status of a task
This service reports the status of a task.
A task is created when a service needs to perform a potentially long-running job. For instance, a task is created when you request to retry the push data for failed trips or for failed crashes.
When a task is created and awaits processing, its status is set to PENDING
. Once processing begins, the status changes to IN_PROGRESS
, and the nbRemainingItems
field is updated as the task advances. Finally, when the task is completed, the status changes to COMPLETED
, the nbRemainingItems
field is set to 0, and the completion date is indicated in the completedAt
field.
If the push trip service is paused while a task is in progress, its status is set to CANCELED
.
Unique identifier of the task
Enterprise API key
GET /v1/enterprise/task/{taskId} HTTP/1.1
Host: service.drivequant.com
x-dq-enterprise-api-key: text
Accept: */*
{
"taskId": "6753030831fe9826412bac5c",
"createdAt": "2024-12-09T14:14:17.574+0000",
"type": "PUSH_FAILED_TRIPS",
"status": "IN_PROGRESS",
"nbItems": 321,
"nbRemainingItems": 12
}
Response
The table below summarizes the response parameters.
taskId
string
Unique identifier of the created task
createdAt
string
Date at which the task was created
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
completedAt
string
Date at which the task was completed (if applicable)
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
type
string
Type of task
Allowed values: PUSH_FAILED_TRIPS
, PUSH_FAILED_CRASHES
status
string
Status of the task
Allowed values: PENDING
, IN_PROGRESS
, COMPLETED
, CANCELED
, FAILED
nbItems
integer
Total number of items to process
nbRemainingItems
integer
Number of items not yet processed
Last updated
Was this helpful?