Restore report

Service version: 1

Purpose

Restore a previously archived Area Analytics report to make it visible in the list of reports again 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}/restore?key={Your_API_Key}

Example

post
URL request example
https://api.tomtom.com/areaanalytics/reports/60d88195-5d0f-4532-8cfd-d644c3401658/restore?key={Your-API-Key}

Request parameters

Required parameters

Description

baseURL string

The base URL for calling TomTom services.

Value: api.tomtom.com

reportId string

Unique identifier of the report to be restored.

key string

Authorization key for access to the API.

Value: Your valid API key.

Required POST headers

Header

Value

Content-Type

application/json

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

200

OK, the report was successfully restored.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found