Traffic API Overview
The Traffic API can be used to get data that is used in the Traffic module in Altitude.
This API uses the queryType parameter to retrieve data. Request information in the API call, such as Speed Map Metrics or Speed Analysis Summary, and it returns that specific set of results. Each query type is a distinct request.
Basic Information
| serviceName | “dna-altitude-traffic” |
| functionName | “getData” for queryTypes that are not marked with an asterisk. Otherwise, one of “createQueryJob”, “cancelQueryJob”, “getJobStatus”, or “getQueryResults”. |
Error Codes
If the API fails, the possible responses for all queryTypes could be one of the following:
| HTTP Status Code | Response Type | Description |
|---|---|---|
| 400 | JSON | Occurs if your API request is a bad request e.g. invalid JSON, invalid queryType, invalid parameter type (e.g. string instead of integer), etc. |
| 401 | JSON | Occurs for various unauthorized tasks e.g. if you didn’t provide credentials in your parameters. |
| 403 | JSON | Occurs for various forbidden tasks e.g. if you have requested data that you have not purchased. |
| 408 | JSON | Occurs if the API call exceeds 10 minutes and times out. |
| 429 | JSON | Occurs if you have exceeded your rate limit. |
| 500 | JSON | Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs. |