Search Jobs

Service version: 1

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

Use this endpoint to list all of your jobs, or just filter out a part of them.

Request data

HTTPS method: `GET`

Constants and parameters enclosed in curly brackets { } must be replaced with their values.

URL format

get

URL request format

https://{baseURL}/traffic/trafficstats/job/search/{versionNumber}?key={Your_API_Key}

Request parameters

The following table describes all of the parameters that can be used in a request. Required parameters must be used or the call will fail. Optional parameters may be used.

Required parameters	Description
`baseURL` string	Base URL for calling the API. Value: `api.tomtom.com`
`versionNumber` string	Service version number. Value: The current value is `1`.
`key` string	Authorization key for access to the API. Value: Your valid API Key.

Optional parameters	Description
`pageIndex` integer	Index of a page with jobs. Page counting starts from 0. When the number of jobs matching the specified search criteria is greater than `perPage` then only part of the jobs will be returned. To retrieve the remaining parts, it may be necessary to repeat the request with an incrementing value of this parameter. Value: `>=0`
`perPage` integer (positive)	Numer of jobs included in the page. The last page may have less jobs. Value: The number of jobs in a page.
`createdAfter` date	Earliest date of requesting jobs (inclusive). Value: Date in the format: `YYYY-MM-DD`. Days change according to the UTC time zone.
`createdBefore` date	Latest date of requesting jobs (inclusive). Value: Date in the format: `YYYY-MM-DD`. Days change according to the UTC time zone.
`completedAfter` date	Earliest date of completing jobs (inclusive). Value: Date in the format: `YYYY-MM-DD`. Days change according to the UTC time zone.
`completedBefore` date	Latest date of completing jobs (inclusive). Value: Date in the format: `YYYY-MM-DD`. Days change according to the UTC time zone.
`name` string	Name of job(s). By default exact match is done. `%` is a special character which allows for partial matching. Value examples: `%London` - search for jobs whose names end with London. `London%` - search for jobs whose names start with London. `%London%` - search for jobs whose name contains London.
`id` integer	Id of a job. Value: A job ID.
`type` string	The type of jobs. Values: Set of comma-separated values from: `routeanalysis` `areaanalysis` `trafficdensity`
`state` string	The current state of jobs. Value: A set of comma-separated values from: `NEW` `SCHEDULED` `MAPMATCHING` `MAPMATCHED` `READING_GEOBASE` `CALCULATIONS` `NEED_CONFIRMATION` `DONE` `ERROR` `REJECTED` `CANCELLED` `EXPIRED`

Request URL example

get

URL request example

https://api.tomtom.com/traffic/trafficstats/job/search/1?key={Your_API_Key}&createdAfter=2018-01-01&createdBefore=2018-02-01&name=%London%&type=routeanalysis&state=DONE

Response data

Response example

Response body example - JSON
1{
"content": [
  {
    "id": 123,
    "name": "London A501 weekdays",
    "type": "Route Analysis",
    "createdAt": "2018-01-02T10:22:33Z",
    "completedAt": "2018-01-02T11:28:22Z",
    "state": "DONE"
  },
  {
    "id": 127,
    "name": "London A501 weekends",
    "type": "Route Analysis",
    "createdAt": "2018-01-02T10:18:47Z",
    "completedAt": "2018-01-02T11:24:07Z",
    "state": "DONE"
  },
  {
    "id": 365,
    "name": "Waterloo Bridge in London City",
    "type": "Route Analysis",
    "createdAt": "2018-01-05T20:18:10Z",
    "completedAt": "2018-01-05T21:24:08Z",
    "state": "DONE"
  }
],
"pageable": {
  "sort": {
    "sorted": true,
    "unsorted": false,
    "empty": false
  },
  "pageSize": 20,
  "pageNumber": 0,
  "offset": 0,
  "paged": true,
  "unpaged": false
},
"totalElements": 3,
"last": false,
"totalPages": 1,
"first": true,
"sort": {
  "sorted": true,
  "unsorted": false,
  "empty": false
},
"numberOfElements": 20,
"size": 20,
"number": 0,
"empty": false
53}

Response fields - JSON

Field	Description
`id` long	The job ID.
`name` string	Name of the job.
`type` string	Type of the job. `Route Analysis` `Area Analysis` `Traffic Density`
`createdAt` datetime	Job creation time. Timestamp in the format: `YYYY-MM-DDTHH:mm:ss.SSSZ`
`completedAt` datetime	Job completion time. Timestamp in the format: `YYYY-MM-DDTHH:mm:ss.SSSZ`
`state` string	The job state: `NEW` `SCHEDULED` `MAPMATCHING` `MAPMATCHED` `READING_GEOBASE` `CALCULATIONS` `NEED_CONFIRMATION` `DONE` `ERROR` `REJECTED` `CANCELLED` `EXPIRED`