Delete dwell time alert history

Deprecation notice

November 6, 2020

• The "Delete dwell time alert history" endpoint has been deprecated.

• This endpoint has been replaced with the generic endpoint to handle all types of Alert Rules: Delete alert history.

• This endpoint will be withdrawn following a 12 month deprecation period.

• The planned withdrawal date is December 1, 2021.

• Following withdrawal, requests to this endpoint may receive an HTTP 404 error in response.

• More details are available at the TomTom deprecation policy page.

Purpose

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

Request data

HTTPS method: DELETE

• Constants and parameters enclosed in curly brackets { } must be replaced with their values.
• Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

https://{baseURL}/geofencing/{versionNumber}/alerts/dwell/history?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command format

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.
• The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Response data

Response body

1{
2  "deleteAllDwellAlertHistoryBefore": "ISO8601_timestamp",
3  "deleteAllDwellAlertHistoryBeforeStatus": "status"
4}

Response fields

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

Response codes

Example

Clear historical Dwell Time Alert entries.

Request format

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

Response body

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