Lite report
Purpose
Create a simple and quick version of the Area Analytics report 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 Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
Format
https://{baseURL}/areaanalytics/reports/lite?key={Your_API_Key}
Example
https://api.tomtom.com/areaanalytics/reports/lite?key={Your-API-Key}
Request parameters
Required parameters | Description |
|---|---|
| The base URL for calling TomTom services. Value: |
| Authorization key for access to the API. Value: Your valid API key. |
Request POST body
Same as in Report creation, see Request POST body example.
Request POST body limitations
The request body has the same structure but with the following constraints:
Required fields | Description |
|---|---|
| The end date must be within 31 days from |
| A list containing only one region definition. |
Required POST headers
Header | Value |
|---|---|
|
Region definition format
A region should be defined as a GeoJSON Feature Object. The feature can contain only the following type of geometry: Polygon. You may define the feature properties name and timezone for the region. Otherwise, they will be generated automatically.
Response data
Same as in classic report result, see Results overview.
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 |
| Bad Request |
| Unauthorized |
| Forbidden |
| Not Found |