Get Tasks
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
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 |
---|---|
| An API Key valid for the requested service. Value: Your valid API Key. |
Optional parameters | Description |
---|---|
| Filter tasks by their status. Possible values: |
| Filter tasks created after this date. Format: |
| Filter tasks created before this date. Format: |
| Page number (zero-based). Default: 0. |
| Number of items per page. Default: 20. |
Request headers
Header | Value |
---|---|
Content-Type | application/json |
Example request
$ 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{2 "content": [3 {4 "id": "65268ff77cd5d952a185b9b7",5 "status": "IN_PROGRESS",6 "junctionIds": ["65268ff77cd5d952a185b9b5", "65268ff77cd5d952a185b9b6"],7 "lastUpdatedAt": "2025-08-06T18:30:01.208Z"8 },9 {10 "id": "65268ff77cd5d952a185b9b8",11 "status": "COMPLETED",12 "junctionIds": ["65268ff77cd5d952a185b9b9"],13 "lastUpdatedAt": "2025-08-06T18:30:01.208Z"14 }15 ],16 "pageable": {17 "pageNumber": 0,18 "pageSize": 2,19 "sort": {20 "empty": false,21 "unsorted": false,22 "sorted": true23 },24 "offset": 0,25 "unpaged": false,26 "paged": true27 },28 "last": true,29 "totalElements": 2,30 "totalPages": 1,31 "first": true,32 "size": 2,33 "number": 0,34 "sort": {35 "empty": false,36 "unsorted": false,37 "sorted": true38 },39 "numberOfElements": 2,40 "empty": false41}
Response fields
Field | Description |
---|---|
| The unique identifier of the raw archive generation task. |
| The current status of the task, such as IN_PROGRESS , COMPLETED , or FAILED . |
| List of junction IDs associated with the raw archive generation task. |
| 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
|
401 | Unauthorized |
403 | Forbidden |
404 | Not Found
|
Error response field
Field | Description |
---|---|
| Problem description. |
Example error response
1{2 "errorMessage": "The end date 2025-08-24 of the time period should be before or equal to today."3}