Analysis Trips Result

Request

Get full trips result by sending a GET request.

Format

GET
URL request example
https://api.tomtom.com/origindestination/1/analysis/flowmatrix/{id}/result/trips?key={apiKey}&dateRange={dateRange}&timeRange={timeRange}

Example

GET
URL request example
https://api.tomtom.com/origindestination/1/analysis/flowmatrix/123/result/trips?key=test-api-key&dateRange=0&timeRange=0

Parameters

ParameterDescription

apiKey

Authorization key for access to the API.

dateRange

Index of date range.

timeRange

Index of time range.

Response

This response will return information about all linked connections.

Reponse structure

FieldDescription

links

Array of link between regions

Result interpretation example

GET
Response body - JSON
1{
2 "links": [[0,0,0,100], [0,1,1,200], ...]
3}

Result contains list of 'links'. Each link contains information about trips between regions and looks like this: [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.

HTTP Response Codes

CodeReason

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found