GET /contacts/v1/contacts/analytics/deleterequests

Retrieves details of contact delete requests for a date range.

NameTypeDescription
startdateutcdatetimeRequiredStart date and time in UTC of the date range.
enddateutcdatetimeRequiredEnd date and time in UTC of the date range.
statusidintDelete request status ID. Use it to filter delete requests by status. Valid values are 1 - Processing, 5 - Completed, and 7 - Invalid.
$pagesizeintNumber of records per page.
$pageintPage number to retrieve.
$orderBystringDetermines which property to use for sorting and the direction in which to sort the data.
StatusNameTypeDescription
200  Retrieved contact delete requests details.
 startDateUtcdatetimeStart date and time in UTC of the date range.
 endDateUtcdatetimeEnd date and time in UTC of the date range.
 pageSizeintegerPage size of results retrieved.
 pageNumberintegerPage number of results retrieved.
 operationsarrayContact delete request information.
 operationsintContact delete request ID.
 operationsdatetimeDate and time in UTC when the contact delete request was created.
 operationsstringStatus of the contact delete request.
 operationsintTotal number of contacts in the contact delete request.
 operationsintNumber of contacts that were deleted in the delete request.
 operationsdatetimeDate and time in UTC when the delete request’s status was most recently modified.
 operationsstringMethod used to delete the contacts.
 statusasofdateutcdatetimeDate and time in UTC when the status was retrieved.
 requestServiceMessageIDguidService message ID for the request.
 responseDateTimedatetimeDate and time in UTC when the response was created in the system.
 resultMessagesarrayArray of messages about the request. Includes details, such as resulttype and resultcode, about a bad request.
 serviceMessageIDguidService message ID for the response.
    
400  The request is missing a required parameter or contains an invalid parameter.
 startDateUtcdatetimeStart date and time in UTC of the date range.
 endDateUtcdatetimeEnd date and time in UTC of the date range.
 pageSizeintegerPage size of results retrieved.
 pageNumberintegerPage number of results retrieved.
 statusasofdateutcdatetimeDate and time in UTC when the status of the contact delete request was retrieved.
 requestServiceMessageIDguidService message ID for the request.
 responseDateTimedatetimeDate and time in UTC when the response was created in the system.
 resultMessagesarrayArray of messages about the request. Includes details, such as resulttype and resultcode, about a bad request.
 serviceMessageIDguidService message ID for the response.

Example Request

Example Response