Sorry, you need to enable JavaScript to visit this website.

Analysis List

Request

Format

https://api.tomtom.com/origindestination/1/analysis?key=<apiKey>[&page=<page>][&limit=<limit>][&name=<name>]

Example

https://api.tomtom.com/origindestination/1/analysis?page=1&limit=15&key=<apiKey>

Parameters

Parameter Description

apiKey

Authorization key for access to the API.

page(optional)

Number of page returned in the response.

limit(optional)

Number of analyses per page.

name(optional)

Filter analyses by name containing given value.

Response

Response structure

Field Description

analysisInfos

List of analysis descriptions.

numberOfAllAnalyses

Number of all analyses in the response.

numberOfPages

Number of pages for provided parameters.

AnalysisInfo structure

Field Description

id

Analysis number id.

name

Job name, given for user’s convenience.

owner

Email of the analysis' owner

status

Job status.
One of the following values:

  • WAITING

  • RUNNING

  • ENDED

  • FAILED

  • CANCELLED

currentProgress

Current value of job progress (0-100)

creationTime

Job creation time in YYYY-MM-DDTHH:mm:ss.SSSZ format

timeDefinition

Time definition of the analysis.

timeDefinition.zoneId

Time zone as TZ database name. For example "Europe/Amsterdam" or "UTC"

timeDefinition.daysOfWeek

Days of week of the analysis.
Allowed values:

  • MONDAY

  • TUESDAY

  • WEDNESDAY

  • THURSDAY

  • FRIDAY

  • SATURDAY

  • SUNDAY

timeDefinition.dateRanges

List of date ranges of the analysis

timeDefinition.timeRanges

List of time ranges of the analysis

tripsCounted

How many trips were counted. Updates when analysis is in progress.

startAnalysisTime

Date and time start of the analysis in format: YYYY-MM-DDTHH:mm:ss.SSSZ

endAnalysisTime

Date and time end of the analysis in format: YYYY-MM-DDTHH:mm:ss.SSSZ

Date range format

Field Description

startDate

Start date of date range in YYYY-MM-DD format

endDate

End date of date range in YYYY-MM-DD format

Time range format

Field Description

startTime

Start time of time range in HH:mm format

endTime

End time of time range in HH:mm format

Response Example

Here is example, showing correct response
{
  "analysisInfos": [
    {
      "id": "1337",
      "name": "Example analysis",
      "owner": "user@example.com",
      "status": "ENDED",
      "currentProgress": 100,
      "creationTime": "2019-07-18T07:39Z",
      "startAnalysisTime": "2019-07-18T07:52Z",
      "startAnalysisTime": "2019-07-18T08:12Z",
      "tripsCounted": 12345,
      "timeDefinition": {
        "dateRanges": [
          {
            "startDate": "2018-12-01",
            "endDate": "2018-12-31"
          }
        ],
        "timeRanges": [
          {
            "startTime": "00:00",
            "endTime": "00:00"
          }
        ],
        "zoneId": "Europe/Warsaw",
        "daysOfWeek": [
          "WEDNESDAY",
          "FRIDAY",
          "MONDAY",
          "TUESDAY",
          "THURSDAY"
        ]
      },
    }
  ],
  "numberOfAllAnalyses": 1,
  "numberOfPages": 1
}

Errors

If there is an error in the supplied parameters or any other internal problem an error response is generated in the requested format.

HTTP Response Codes
Code Reason

401

Unauthorized

403

Forbidden

404

Not Found

You are here