Get Task by ID

Service version: v1 Last edit: 2025.10.30

Important Note Explore ready-to-use traffic reports and data visualizations immediately by signing up for a 30-day free trial on the MOVE Portal. Once registered, you’ll receive an API key to start using the Traffic Analytics APIs right away. Alternatively, you may contact our Sales team for a tailored solution.

Purpose

The Get Task Status by ID endpoint retrieves the status of a specific raw archive generation task.

Request data

You can retrieve the status of a task by sending a GET request.

HTTPS method: `GET`

get

URL request example

1
https://api.tomtom.com/junction-analytics/1/archive/raw-data/tasks/{id}?key={Your_API_Key}

Request parameters

The following table shows the query parameters:

Required parameters must be used or the call will fail.
Optional parameters may be used.

Required parameters	Description
`id` string	The unique identifier of the raw archive generation task. Value: The ID of the task you want to check.
`key` string	An API Key valid for the requested service. Value: Your valid API Key.

Request headers

Header	Value
Content-Type	`application/json`

Example request

get

curl command example

1
$ curl 'https://api.tomtom.com/junction-analytics/1/archive/raw-data/tasks/65268ff77cd5d952a185b9b7?key={Your_API_Key}' -i -X GET

Response data

This response returns the status of the raw archive generation task.

Response body example

1
{
2
  "id": "65268ff77cd5d952a185b9b7",
3
  "status": "IN_PROGRESS",
4
  "batchStatus": "IN_PROGRESS",
5
  "junctionIds": ["65268ff77cd5d952a185b9b5", "65268ff77cd5d952a185b9b6"],
6
  "lastUpdatedAt": "2025-08-06T18:30:01.208Z"
7
}

Response fields

Field	Description
`id` string	The unique identifier of the raw archive generation task.
`status` string	The current status of the task, such as `IN_PROGRESS`, `COMPLETED`, or `FAILED`.
`status` string	The current status of the batch task, such as `IN_PROGRESS`, `COMPLETED`, or `FAILED`.
`junctionIds` array of strings	List of junction IDs associated with the raw archive generation task.
`lastUpdatedAt` string	The timestamp of the last update to the task status, in ISO 8601 format.

Errors

The following table shows the HTTP error response codes.

Code	Description
401	Unauthorized
403	Forbidden
404	Not Found Task not found for id 65268ff77cd5d952a185b9b7.

Code

Description

401

Unauthorized

403

Forbidden

404

Not Found

Task not found for id 65268ff77cd5d952a185b9b7.

Error response field

Field	Description
`errorMessage` string	Problem description.

Example error response

Response error - JSON

1
{
2
  "errorMessage": "Access to tasks statuses is denied."
3
}