Analysis Trips Result as a CSV file
Purpose
Get the full trips result as a CSV file by sending a GET request.
Request data
HTTPS Method: GET
For ease of viewing and identification:
- Constants and 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
https://{baseURL}/origindestination/{versionNumber}/analysis/flowmatrix/{id}/result/trips/csv?key={Your_API_Key}&dateRange={dateRange}&timeRange={timeRange}
Example
https://api.tomtom.com/origindestination/1/analysis/flowmatrix/123/result/trips/csv?key={Your_API_Key}&dateRange=0&timeRange=0
Request parameters
Required parameters | Description |
---|---|
| The base URL for calling TomTom services. Value: |
| Version of the service to call. Value: The current value is |
| Analysis number id. Value: The analysis number id. |
| Authorization key for access to the API. Value: Your valid API Key. |
| Index of the date range. Value: Example: |
| Index of the time range. Value: Example: |
Response data
This response will return a CSV file containing all trips for all possible combinations of a single origin and destination.
Response structure
The response contains a CSV file which should be self describing.
- The first row contains labels.
- The following rows contain data.
The first two columns are reserved for region names and the third is reserved for the trips value.
Response example
1Origin,Destination,Trips2Region A,Region A,13Region A,External,24External,Region A,35External,External,4
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
Code | Meaning & possible causes |
---|---|
| OK |
| Bad request |
| Unauthorized |
| Forbidden |
| Not Found |