queryType: getSavedResults*
The getSavedResults queryType is passed to the API to get results for a given saved analysis, and return time series secondary output tables.
Note:
See Special Case APIs for more information.
This functionality is currently only supported for Origin and Destination, Route Analysis, O/D Segment Analysis, Stop Analytics, and Regional Travel Metrics.
Parameters
These parameters should be passed to the functionParameters object regardless of which method you choose to make an API request.
| Parameter | Description | Type | Defined Value Set | Value Req'd |
|---|---|---|---|---|
| queryType | Must equal "getSavedResults". | STRING | "getSavedResults" | Y |
| analysisJobId | The job id that was used to generate the analysis. Can be grabbed from the getSavedAnalyses API. | STRING | - | N |
| analysisType | Must equal the queryType of the results you are trying to get. | STRING | Any queryType whose results are saved | Y |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | JSON | The requested data. |
| 401 | JSON | Occurs for various unauthorized tasks, such as not providing credentials in your parameters. |
| 500 | JSON | Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs. |
Response Schema
The response schema for this API is dependent on what the queryType is of the analysis you are retrieving. For example, if you are loading up a saved origin/destination matrix, then the response schema will match that of getOriginDestinationMatrix API.
Sample parameters
{
"queryType": "getSavedResults",
"analysisJobId": "<your saved analysis job id>",
"analysisType": "getRegionalDomicileAnalytics"
}