Archive report
Purpose
Archive a specified Area Analytics report to hide it from the default list of retrieved reports by sending a POST request.
Request data
HTTPS method: POST
For ease of viewing and identification:
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- See the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
Format
post
URL request format
https://{baseURL}/areaanalytics/reports/{reportId}/archive?key={Your_API_Key}
Example
post
URL request example
https://api.tomtom.com/areaanalytics/reports/60d88195-5d0f-4532-8cfd-d644c3401658/archive?key={Your-API-Key}
Request parameters
Required parameters | Description |
|---|---|
| The base URL for calling TomTom services. Value: |
| Unique identifier of the report to be archived. |
| Authorization key for access to the API. Value: Your valid API key. |
Required POST headers
Header | Value |
|---|---|
|
Response data
No data is returned.
Errors
If the supplied parameters are invalid or an internal error occurs, the API returns an error response in the requested format.
Response codes
Code | Meaning & possible causes |
|---|---|
| OK, the report was successfully archived. |
| Bad Request |
| Unauthorized |
| Forbidden |
| Not Found |