Analysis Partial Histogram Result

Purpose

Get a partial histogram result by sending a POST request. The analysis must have been created with tripStats enabled.

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 parameters table for their values. The generic request format is as follows.

Format

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

Example

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

Required parameters

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

Required POST headers

Response data

This response returns one histogram, merged over every origin, destination and via combination you selected. It is available once the analysis reaches the ACCEPTED status.

Response example

1
{
2
  "bucketInterval": 1,
3
  "unit": "HOUR",
4
  "histogram": {
5
    "4": 0.02,
6
    "5": 0.05,
7
    "6": 0.18,
8
    "7": 0.51,
9
    "8": 1.96,
10
    "9": 3.71,
11
    "10": 8.72,
12
    "11": 9.29,
13
    "12": 9.97,
14
    "13": 10.02,
15
    "14": 9.95,
16
    "15": 10.92,
17
    "16": 10.95,
18
    "17": 10.89,
19
    "18": 10.66,
20
    "19": 8.95
21
  }
22
}

Response structure

Reading the normalized trip count

Each value is the normalized trip count for this date range and time range. See Normalized probe counts.

• With vias left empty and every region listed in origins and destinations, the buckets add up to about 100. A narrower selection adds up to less.
• With vias filled in, a trip that passed through several of the selected regions is counted in several entries before they are merged, so the buckets add up to more than 100.
• AVG_SPEEDS has its own population: trips whose average speed could not be computed are left out of both the buckets and the total, so this histogram is not comparable cell by cell with the other three.
• Histograms of two different results - a different dateRange or timeRange - have different denominators and must not be added together.

LENGTHS and DURATIONS describe the part of a trip that lies inside the analyzed regions, from the origin region to the destination region. HOURS_OF_DAY is the hour at which the trip entered its origin region, the same moment that decides which time range the trip is counted in.

Response types

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