Flow Matrix Analysis
Introduction
The Flow Matrix API calculates statistics of origin and destination between all defined regions.
It provides all via waypoints for all origin and destination pairs. Each region in the input is
treated as origin, destination, and a "Via" region at the same time. This is a simplified result you get
for 3 defined regions A, B and C.
Output example covering no via restrictions
_ | A | B | C |
|---|---|---|---|
| A | 10 | 1 | 1 |
| B | 2 | 8 | 1 |
| C | 1 | 4 | 7 |
Output example covering via restrictions
via B | A | B | C |
|---|---|---|---|
| A | 1 | 1 | 0 |
| B | 2 | 8 | 1 |
| C | 0 | 4 | 2 |
Similarly you get results for via A and via B. This API is asynchronous.
Using this API
There are some important notes about using this API:
- The latitude and longitude coordinates are in EPSG4326 / WGS84 format for both input and output. Other coordinate systems are not supported.
- The maximum supported region area sum in total is 20000 km^2. Requests with a bigger region area sum will be rejected.
- The maximum number of regions is 600.
- The maximum number of date ranges is 4.
- The maximum number of time ranges is 24.
- As the service is asynchronous it can take a while before results are available, depending on how
busy the service is.
- Do not repost your request multiple times if you do not get feedback within seconds.
- We will ensure that the results are delivered.