Analysis Trips Result

Service version: 1
Last edit: 2022.08.22

Purpose

Get the full trips result by sending a GET request.

Request data

HTTPS Method: GET

For ease of viewing and identification:

  • Constants and parameters enclosed in curly brackets &#123 } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

Format

https://{baseURL}/origindestination/{versionNumber}/analysis/flowmatrix/{id}/result/trips?key={Your_API_Key}&dateRange={dateRange}&timeRange={timeRange}

Example

https://api.tomtom.com/origindestination/1/analysis/flowmatrix/123/result/trips?key={Your_API_Key}&dateRange=0&timeRange=0

Request parameters

Required parameters

Description

baseURL
string

The base URL for calling TomTom services.


Value: api.tomtom.com
versionNumber
string

Version of the service to call.


Value: The current value is 1.

id
integer

Analysis number id.


Value: The analysis number id.

key
string

Authorization key for access to the API.


Value: Your valid API Key.

dateRange
integer

Index of the date range.


Value: Example: 0

timeRange
integer

Index of the time range.


Value: Example: 0

Response data

This response will return information about all linked connections.

Reponse structure

Field

Description

links
array

An array of links between regions.


Value: See the following example.

Result interpretation example

1{
2 "links": [[0,0,0,100], [0,1,1,200], ...]
3}

The result contains a list of 'links'. Each link contains information about trips between regions and looks like this:
[0,0,0,100] - [Origin region index (number), Destination region index (number), Via region index (number), Amount of trips (number)].

Errors

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

Response codes

Code

Meaning & possible causes

200OK
400Bad request
401Unauthorized
403Forbidden
404Not Found