Get Tasks

Service version: v1

Last edit: 2025.02.25

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 Tasks endpoint retrieves the tasks with current statuses. This allows you to monitor the progress of tasks related to generating raw data archives for junctions.

Request data

You can retrieve tasks statuses by sending a GET request.

HTTPS method: `GET`

get

URL request example

https://api.tomtom.com/junction-analytics/v1/archive/raw-data/tasks?key={Your_API_Key}&page={page}&size={size}&status={status}&from={fromDate}&to={toDate}

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
`key` string	An API Key valid for the requested service. Value: Your valid API Key.

Optional parameters	Description
`status` string	Filter tasks by their status. Possible values: `IN_PROGRESS`, `COMPLETED`, `FAILED`. Default: all statuses.
`from` string	Filter tasks created after this date. Format: `YYYY-MM-DD`. Default: no filter.
`to` string	Filter tasks created before this date. Format: `YYYY-MM-DD`. Default: no filter.
`page` integer	Page number (zero-based). Default: 0.
`size` integer	Number of items per page. Default: 20.

Request headers

Header	Value
Content-Type	`application/json`

Example request

get

curl command example

$ curl 'https://api.tomtom.com/junction-analytics/v1/archive/raw-data/tasks?key={Your_API_Key}&status=IN_PROGRESS&page=0&size=20&from=2024-08-01&to=2025-08-01' -i -X GET

Response data

This response returns a list of statuses for raw archive generation tasks.

Response body example

1{
"content": [
  {
    "id": "65268ff77cd5d952a185b9b7",
    "status": "IN_PROGRESS",
    "batchStatus": "IN_PROGRESS",
    "junctionIds": ["65268ff77cd5d952a185b9b5", "65268ff77cd5d952a185b9b6"],
    "lastUpdatedAt": "2025-08-06T18:30:01.208Z"
  },
  {
    "id": "65268ff77cd5d952a185b9b8",
    "status": "COMPLETED",
    "batchStatus": "IN_PROGRESS",
    "junctionIds": ["65268ff77cd5d952a185b9b9"],
    "lastUpdatedAt": "2025-08-06T18:30:01.208Z"
  }
],
"pageable": {
    "pageNumber": 0,
    "pageSize": 2,
    "sort": {
        "empty": false,
        "unsorted": false,
        "sorted": true
    },
    "offset": 0,
    "unpaged": false,
    "paged": true
},
"last": true,
"totalElements": 2,
"totalPages": 1,
"first": true,
"size": 2,
"number": 0,
"sort": {
    "empty": false,
    "unsorted": false,
    "sorted": true
},
"numberOfElements": 2,
"empty": false
43}

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`.
`batchStatus` 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
400	Bad Request The end date 2025-08-24 of the time period should be before or equal to today. The start date 2025-08-24 of the time period should be before today. The start date 2025-08-24 of the time period should be before or equal to the end date 2025-08-24.
401	Unauthorized
403	Forbidden
404	Not Found Tasks not found for the given period or status.

Error response field

Field	Description
`errorMessage` string	Problem description.

Example error response

Response error - JSON
1{
2  "errorMessage": "The end date 2025-08-24 of the time period should be before or equal to today."
3}