Analysis Partial Histogram Result

Request

Get partial histogram result by sending a POST request.

Format

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

Example

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

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

This response will return array where each index is histogram’s bucket with information about number of trips which started in given origin, went through given vias and ended in given destinations. The array size depends on histogram type you choose:

Response structure

Sample response for HOURS_OF_DAY histogram contains following data. Each value of histogram pairs is a number of trips which started in given origins, went through given vias and ended in given destinations for given hour.

Result interpretation example

1{
2  "bucketInterval": 1,
3  "unit": "HOUR",
4  "histogram": {
5    "4": 6,
6    "5": 15,
7    "6": 52,
8    "7": 148,
9    "8": 568,
10    "9": 10766,
11    "10": 39039,
12    "11": 41573,
13    "12": 44617,
14    "13": 44866,
15    "14": 44537,
16    "15": 48869,
17    "16": 49014,
18    "17": 48767,
19    "18": 47713,
20    "19": 40060
21  }
22}

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