GET /contacts/v1/contacts/analytics/deleterequests
Retrieves details of contact delete requests for a date range.
| Name | Type | Description | |
|---|---|---|---|
| startdateutc | datetime | Required | Start date and time in UTC of the date range. |
| enddateutc | datetime | Required | End date and time in UTC of the date range. |
| statusid | int | Delete request status ID. Use it to filter delete requests by status. Valid values are 1 - Processing, 5 - Completed, and 7 - Invalid. | |
| $pagesize | int | Number of records per page. | |
| $page | int | Page number to retrieve. | |
| $orderBy | string | Determines which property to use for sorting and the direction in which to sort the data. |
| Status | Name | Type | Description |
|---|---|---|---|
| 200 | Retrieved contact delete requests details. | ||
| startDateUtc | datetime | Start date and time in UTC of the date range. | |
| endDateUtc | datetime | End date and time in UTC of the date range. | |
| pageSize | integer | Page size of results retrieved. | |
| pageNumber | integer | Page number of results retrieved. | |
| operations | array | Contact delete request information. | |
| operations:operationid | int | Contact delete request ID. | |
| operations:receiveddateutc | datetime | Date and time in UTC when the contact delete request was created. | |
| operations:status | string | Status of the contact delete request. | |
| operations:totalcontactcount | int | Total number of contacts in the contact delete request. | |
| operations:completedcontactcount | int | Number of contacts that were deleted in the delete request. | |
| operations:laststatusdateutc | datetime | Date and time in UTC when the delete request’s status was most recently modified. | |
| operations:deletemethod | string | Method used to delete the contacts. | |
| statusasofdateutc | datetime | Date and time in UTC when the status was retrieved. | |
| requestServiceMessageID | guid | Service message ID for the request. | |
| responseDateTime | datetime | Date and time in UTC when the response was created in the system. | |
| resultMessages | array | Array of messages about the request. Includes details, such as resulttype and resultcode, about a bad request. | |
| serviceMessageID | guid | Service message ID for the response. | |
| 400 | The request is missing a required parameter or contains an invalid parameter. | ||
| startDateUtc | datetime | Start date and time in UTC of the date range. | |
| endDateUtc | datetime | End date and time in UTC of the date range. | |
| pageSize | integer | Page size of results retrieved. | |
| pageNumber | integer | Page number of results retrieved. | |
| statusasofdateutc | datetime | Date and time in UTC when the status of the contact delete request was retrieved. | |
| requestServiceMessageID | guid | Service message ID for the request. | |
| responseDateTime | datetime | Date and time in UTC when the response was created in the system. | |
| resultMessages | array | Array of messages about the request. Includes details, such as resulttype and resultcode, about a bad request. | |
| serviceMessageID | guid | Service message ID for the response. |
Example Request
Example Response