Sorry, you need to enable JavaScript to visit this website.

Delete dwell time alert history

 

Service version: 1
Last edit: 2020.09.30

On this page

Purpose

This endpoint is used to clear historical Dwell Time Alert entries.

We highly recommend using the new, generic endpoint to handle all types of historical Alert entries: Delete Alert History.

Request data

HTTPS method: DELETE

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in normal text.
https://baseURL/geofencing/versionNumber/alerts/dwell/history?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -X DELETE 'https://baseURL/geofencing/versionNumber/alerts/dwell/history?key=Your_API_Key&adminKey=Your_Admin_Key'

Request parameters

The following table describes the parameters that can be used in a Request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of Request parameters is not important.
Required parameters
Parameter Description
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your valid API Key.
adminKey
string
An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.
Optional parameters
Note: There are no optional parameters in this endpoint.

▲ Return to top

Response data

Response body

{
  "deleteAllDwellAlertHistoryBefore": "ISO8601_timestamp",
  "deleteAllDwellAlertHistoryBeforeStatus": "status"
}

Response fields

The following table describes all of the fields that can appear in a Response.

Primary fields
Field Description
deleteAllDwellAlertHistoryBefore
string
Timestamp (ISO 8601 format) marking the moment before the history will be deleted.
deleteAllDwellAlertHistoryBeforeStatus
string
Status of the deletion process. Live status can be checked in the current options list.
Value: PROCESSING

HTTP Response codes

Code Meaning and possible causes
200 OK: Deletion of history has begun.
403 Forbidden:
  • The provided Admin Key is invalid.
  • The Admin Key is missing.

▲ Return to top

Examples

Example: Clear historical Dwell Time Alert entries.

Request format

https://api.tomtom.com/geofencing/1/alerts/dwell/history?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8

Response body

{
  "deleteAllDwellAlertHistoryBefore": "2020-02-20T08:32:20.843Z",
  "deleteAllDwellAlertHistoryBeforeStatus": "PROCESSING"
}

▲ Return to top