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.

When a task is created and awaiting processing, its status is 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 you have your enterprise API key, you can try the API via this link.

Get the current status of a task

GEThttps://service.drivequant.com/v1/enterprise/task/{taskId}

Path parameters

taskId*string

Unique identifier of the task

Header parameters

Response

200401404

OK

Body

application/json

taskIdstring

Unique identifier of the task

Example: "6753030831fe9826412bac5c"

createdAtstring (date-time)

Date at which the task was created

Example: "2024-12-09T14:14:17.574+0000"

completedAtnullable string (date-time)

Date at which the task was completed (if in COMPLETED status)

Example: "2024-12-09T14:19:17.574+0000"

typeenum

Type of the task

Example: "PUSH_FAILED_TRIPS"

PUSH_FAILED_TRIPS

statusenum

Current status of the task

Example: "IN_PROGRESS"

PENDINGIN_PROGRESSCOMPLETED

nbItemsinteger

Total number of items to process

Example: 321

nbRemainingItemsinteger

Number of items remaining to process

Example: 12

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v1/enterprise/task/{taskId}', {
    method: 'GET',
    headers: {
      "x-dq-enterprise-api-key": "text"
    },
});
const data = await response.json();

Response

200404

{
  "taskId": "6753030831fe9826412bac5c",
  "createdAt": "2024-12-09T14:14:17.574+0000",
  "completedAt": "2024-12-09T14:19:17.574+0000",
  "type": "PUSH_FAILED_TRIPS",
  "status": "IN_PROGRESS",
  "nbItems": 321,
  "nbRemainingItems": 12
}

Response

The table below summarizes the response parameters.

Name	Type	Description
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
status	string	Status of the task Allowed values: PENDING, IN_PROGRESS, COMPLETED
nbItems	integer	Total number of items to process
nbRemainingItems	integer	Number of items not yet processed