Developer

Delete alert history

Service version: 1
Last edit: 2022.09.01

Purpose

This endpoint is used to clear historical 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 their values. The generic request format is as follows.

URL request format

delete
URL request format
https://{baseURL}/geofencing/{versionNumber}/alerts/history?key={Your_API_Key}&adminKey={Your_Admin_Key}&alertType={string}

curl command request format

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

Note: There are no optional parameters in this endpoint.

Required parameters

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, PROXIMITY, or ALL

Response data

Response body

Response body format - JSON
1{
2  "deleteAllTransitionAlertHistoryBefore": "ISO8601_timestamp",
3  "deleteAllTransitionAlertHistoryBeforeStatus": "status",
4  "deleteAllDwellAlertHistoryBefore": "ISO8601_timestamp",
5  "deleteAllDwellAlertHistoryBeforeStatus": "status",
6  "deleteAllObjectCountAlertHistoryBefore": "ISO8601_timestamp",
7  "deleteAllObjectCountAlertHistoryBeforeStatus": "status",
8  "deleteAllProximityAlertHistoryBefore": "ISO8601_timestamp",
9  "deleteAllProximityAlertHistoryBeforeStatus": "status"
10}

Response fields

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

Optional fields

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"

deleteAllProximityAlertHistoryBefore
string

Timestamp (ISO 8601 format) marking the moment before the history of Proximity Alerts will be deleted.

deleteAllProximityAlertHistoryBeforeStatus
string

Status of the Proximity Alerts deletion process. Live status can be checked in the current options list.
Value: "PROCESSING" or "DELETED"

Response codes

Code

Meaning & possible causes

200

OK: Deletion of history has begun.

403

Forbidden:

  • The provided Admin Key is invalid.
  • The Admin Key is missing.

Examples

Clear historical Transition Alert entries

URL request example

delete
URL request example
https://api.tomtom.com/geofencing/1/alerts/history?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8&alertType=TRANSITION

Response body example

Response body example - JSON
1{
2  "deleteAllTransitionAlertHistoryBefore": "2020-02-20T08:32:20.843Z",
3  "deleteAllTransitionAlertHistoryBeforeStatus": "PROCESSING"
4}

Clear all historical Alert entries.

URL request example

delete
URL request example
https://api.tomtom.com/geofencing/1/alerts/history?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8&alertType=ALL

Response body example

Response body example - JSON
1{
2  "deleteAllTransitionAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
3  "deleteAllTransitionAlertHistoryBeforeStatus": "DELETED",
4  "deleteAllDwellAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
5  "deleteAllDwellAlertHistoryBeforeStatus": "PROCESSING",
6  "deleteAllObjectCountAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
7  "deleteAllObjectCountAlertHistoryBeforeStatus": "PROCESSING",
8  "deleteAllProximityAlertHistoryBefore": "2020-02-20T08:33:07.502Z",
9  "deleteAllProximityAlertHistoryBeforeStatus": "PROCESSING"
10}