Stop Analytics API Overview
The Altitude Stop Analytics module allows users to understand in aggregate where vehicles are stopping and get contextual information regarding those stops.
This API uses the queryType parameter to retrieve data. Request information in the API call, such as Stop Analytics or Regional Domicile Analytics, and it returns that specific set of results. Each query type is a distinct request.
New purpose-built O/D APIs are available for analytical use cases that require more specific attribution methods. See Closed O/D and Segment Flow API comparison for details.
Basic Information
Limit the query to a one-month date range and a geographic area of up to three counties for best performance.
| serviceName | "dna-altitude-stop-analytics" |
| functionName | 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, such as not providing credentials in your parameters. |
| 403 | JSON | Occurs for various forbidden tasks, such as for requesting 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. |
