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

Analysis List

Request

Format

https://<baseURL>/origindestination/<versionNumber>/analysis?key=<apiKey>[&page=<page>][&limit=<limit>][&name=<name>]

Example

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

Parameters

The table below describes the parameters in a request.

Request parameters
parameter Description Required? Type / Values Default Value

baseURL

Base URL for calling the API.

Yes

api.tomtom.com

-

versionNumber

Service version number. The current value is 1.

Yes

1

-

apiKey

Authorization key for access to the API.

Yes

API Key

-

page

Number of page returned in the response.

No

Integer

-

limit

Limit number of analyses per page.

No

Integer

-

name

Filter results containing given value.

No

String

-

Response

The table below describes all of the fields that can appear in response.

Structure of response (JSON)
Field(s) Description Type / Values

analysisInfos

List of analysis descriptions. See structure here.

List of AnalysisInfo objects with following properties:

  • name

  • status

  • owner

  • id

  • type

  • statusDetails

  • ownerApiKey

  • creationTime

  • startAnalysisTime

  • endAnalysisTime

  • currentProgress

  • maxProgress

numberOfAllAnalyses

Number of all analyses in the response.

Integer

numberOfPages

Number of pages for provided parameters.

Integer

AnalysisInfo structure

The table below describe structure of analysisInfo.

Structure of analysisInfo
Field(s) Description Type / Values

name

Analysis name

String

status

Job status.

String:

  • WAITING

  • RUNNING

  • ENDED

  • FAILED

  • CANCELLED

owner

Owner of the analysis.

String

id

Analysis id number.

Integer

type

Type of analysis.

String / "FLOW_MATRIX"

statusDetails

Detailed information about status

String

ownerApiKey

Api key of analysis owner

String

creationTime

Date and time of analysis creation.

Timestamp in format: YYYY-MM-DDTHH:mm:ss.SSSZ

startAnalysisTime

Start sate and time of analysis.

Timestamp in format: YYYY-MM-DDTHH:mm:ss.SSSZ

endAnalysisTime

End date and time of analysis.

Timestamp in format: YYYY-MM-DDTHH:mm:ss.SSSZ

currentProgress

Current value of job progress.

Integer (0-1000)

maxProgress

Maximum value of job progress.

Integer (1000)

Final Example

Here is example, showing correct final response
{
  "analysisInfos": [
    {
      "name": "report1",
      "status": "CANCELLED",
      "owner": user@example.com,
      "id": 512,
      "type": "FLOW_MATRIX",
      "statusDetails": null,
      "ownerApiKey": "test-api-key",
      "creationTime": "2018-10-09T11:42:09.461Z",
      "startAnalysisTime": "2018-10-09T11:42:09.573Z",
      "endAnalysisTime": "2018-10-09T11:44:44.501Z",
      "currentProgress": 333,
      "maxProgress": 1000
    },
    {
      "name": "report2",
      "status": "ENDED",
      "owner": "user@example.com",
      "id": 511,
      "type": "FLOW_MATRIX",
      "statusDetails": null,
      "ownerApiKey": "test-api-key",
      "creationTime": "2018-04-19T09:59:06.368Z",
      "startAnalysisTime": "2018-04-19T09:59:06.952Z",
      "endAnalysisTime": "2018-04-19T10:03:09.607Z",
      "currentProgress": 1000,
      "maxProgress": 1000,
    }
  ],
  "numberOfAllAnalyses": 2,
  "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