Analysis Partial Trips Result

Purpose

Get a partial trips result by sending a POST request.

Request data

HTTPS Method: POST

For ease of viewing and identification:

• Parameters enclosed in curly brackets { } 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

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

Example

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

Required parameters

Optional parameters

Required POST headers

Request POST body example

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

Request POST body stucture

Response data

This response returns the normalized trip count for trips that started at a given origin, went through the given vias, and ended at a given destination. The result is available once the analysis reaches the ACCEPTED status.

Response example

A link has five positions:

1
{
2
  "links": [[0,0,0,0,28.5], [0,1,1,2,3.0], ...]
3
}

[0,0,0,0,28.5] - [Origin region index (number), Destination region index (number), Via region index (number), externalEndsCode (number), Normalized trip count (number)]

Reading the normalized trip count

The last position of a link is the normalized trip count for this date range and time range - for the whole analysis, not for the subset you asked about, as described at Normalized probe counts. Filtering by origins, destinations or vias therefore never rescales the values: it only removes links.

• With vias left empty, the returned links add up to at most 100, and to exactly about 100 when you ask for all origins and all destinations.
• With vias filled in, the same trip can appear in several links, so the values add up to more than the origin-destination view.
• Normalized values of two different results - a different dateRange or timeRange - have different denominators and must not be added together.

Response structure

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