Delete alert history
Service version: 1
Last edit: 2020.09.30
On this page
Purpose
This endpoint is used to clear historical Alert entries.
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/history?key=Your_API_Key&adminKey=Your_Admin_Key&alertType=string
curl command
curl -X DELETE 'https://baseURL/geofencing/versionNumber/alerts/history?key=Your_API_Key&adminKey=Your_Admin_Key&alertType=string
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 .
|
alertType string |
Type of the Alerts to delete. Value: TRANSITION , DWELL , OBJECT_COUNT , or ALL
|
Optional parameters | |
Note: There are no optional parameters in this endpoint. |
Response data
Response body
{
"deleteAllTransitionAlertHistoryBefore": "ISO8601_timestamp",
"deleteAllTransitionAlertHistoryBeforeStatus": "status",
"deleteAllDwellAlertHistoryBefore": "ISO8601_timestamp",
"deleteAllDwellAlertHistoryBeforeStatus": "status",
"deleteAllObjectCountAlertHistoryBefore": "ISO8601_timestamp",
"deleteAllObjectCountAlertHistoryBeforeStatus": "status"
}
Response fields
The following table describes all of the fields that can appear in a Response.
Optional fields | |
---|---|
Field | Description |
deleteAllTransitionAlertHistoryBefore string |
Timestamp (ISO 8601 format) marking the moment before the history of Transition Alerts will be deleted. |
deleteAllTransitionAlertHistoryBeforeStatus string |
Status of the Transition Alerts deletion process. Live status can be checked in the current options list. Value: "PROCESSING" or "DELETED"
|
deleteAllDwellAlertHistoryBefore string |
Timestamp (ISO 8601 format) marking the moment before the history of Dwell Alerts will be deleted. |
deleteAllDwellAlertHistoryBeforeStatus string |
Status of the Dwell Alerts deletion process. Live status can be checked in the current options list. Value: "PROCESSING" or "DELETED"
|
deleteAllObjectCountAlertHistoryBefore string |
Timestamp (ISO 8601 format) marking the moment before the history of Object Count Alerts will be deleted. |
deleteAllObjectCountAlertHistoryBeforeStatus string |
Status of the Object Count Alerts deletion process. Live status can be checked in the current options list. Value: "PROCESSING" or "DELETED"
|
HTTP Response codes
Code | Meaning and possible causes |
---|---|
200 |
OK: Deletion of history has begun. |
403 |
Forbidden:
|
Examples
Example: Clear historical Transition Alert entries.
Request format
https://api.tomtom.com/geofencing/1/alerts/history?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8&alertType=TRANSITION
Response body
{
"deleteAllTransitionAlertHistoryBefore": "2020-02-20T08:32:20.843Z",
"deleteAllTransitionAlertHistoryBeforeStatus": "PROCESSING"
}
Example: Clear all historical Alert entries.
Request format
https://api.tomtom.com/geofencing/1/alerts/history?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8&alertType=ALL
Response body
{
"deleteAllTransitionAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
"deleteAllTransitionAlertHistoryBeforeStatus": "DELETED",
"deleteAllDwellAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
"deleteAllDwellAlertHistoryBeforeStatus": "PROCESSING",
"deleteAllObjectCountAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
"deleteAllObjectCountAlertHistoryBeforeStatus": "PROCESSING"
}