Analysis Partial Trips Result

Purpose

Get a partial trips result by sending a POST request.

Request data

Format

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

Example

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

Required POST Headers

Parameters

Request body stucture

Request body example

1{
2    "origins": [0,1,2,3],
3    "destinations": [4,5,6,7,8],
4    "vias": [10]
5}

Response data

This response will return information about the number of trips which started in a given origin, went through given vias, and ended in given origins. The following table describes all of the fields that can appear in a response.

Reponse structure

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: [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