GET /contacts/v1/contacts/analytics/deleterequests

Retrieves details of contact delete requests for a date range.

URL Parameters

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.

Responses

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.

Usage

Example Request

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2GET contacts/v1/contacts/analytics/deleterequests?startdateutc=2019-02-18T00%3A00%3A00&enddateutc=2019-03-19T00%3A00%3A00&%24page=1&%24pagesize=20&%24orderby=operationId%20desc&statusid=5
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response

1{
2   "startDateUtc":"2019-02-18T00:00:00",
3   "endDateUtc":"2019-03-19T00:00:00",
4   "statusAsOfDateUtc":"2019-03-19T19:33:17.496471Z",
5   "pageNumber":1,
6   "pageSize":20,
7   "operations":[
8      {
9         "operationId":22944,
10         "totalContactCount":1,
11         "completedContactCount":1,
12         "receivedDateUtc":"2019-03-04T22:42:00",
13         "status":"Completed",
14         "lastStatusDateUtc":"2019-03-19T04:47:40.293",
15         "deleteMethod":"Contact Key/ID"
16      },
17      {
18         "operationId":22943,
19         "totalContactCount":1,
20         "completedContactCount":1,
21         "receivedDateUtc":"2019-03-04T22:41:00",
22         "status":"Completed",
23         "lastStatusDateUtc":"2019-03-19T04:47:40.293",
24         "deleteMethod":"Contact Key/ID"
25      },
26      {
27         "operationId":22625,
28         "totalContactCount":1,
29         "completedContactCount":1,
30         "receivedDateUtc":"2019-02-26T23:26:00",
31         "status":"Completed",
32         "lastStatusDateUtc":"2019-03-13T10:10:17.9",
33         "deleteMethod":"Contact Key/ID"
34      },
35      {
36         "operationId":22624,
37         "totalContactCount":1,
38         "completedContactCount":1,
39         "receivedDateUtc":"2019-02-26T23:25:00",
40         "status":"Completed",
41         "lastStatusDateUtc":"2019-03-13T10:10:17.9",
42         "deleteMethod":"Contact Key/ID"
43      },
44      {
45         "operationId":22598,
46         "totalContactCount":1,
47         "completedContactCount":1,
48         "receivedDateUtc":"2019-02-26T16:22:00",
49         "status":"Completed",
50         "lastStatusDateUtc":"2019-03-13T00:41:55.317",
51         "deleteMethod":"Contact Key/ID"
52      },
53      {
54         "operationId":22597,
55         "totalContactCount":1,
56         "completedContactCount":1,
57         "receivedDateUtc":"2019-02-26T16:21:00",
58         "status":"Completed",
59         "lastStatusDateUtc":"2019-03-13T00:41:55.317",
60         "deleteMethod":"Contact Key/ID"
61      },
62      {
63         "operationId":22594,
64         "totalContactCount":1,
65         "completedContactCount":1,
66         "receivedDateUtc":"2019-02-26T04:34:00",
67         "status":"Completed",
68         "lastStatusDateUtc":"2019-03-12T13:36:48.677",
69         "deleteMethod":"Contact Key/ID"
70      },
71      {
72         "operationId":22593,
73         "totalContactCount":1,
74         "completedContactCount":1,
75         "receivedDateUtc":"2019-02-26T04:33:00",
76         "status":"Completed",
77         "lastStatusDateUtc":"2019-03-12T13:36:48.677",
78         "deleteMethod":"Contact Key/ID"
79      },
80      {
81         "operationId":22544,
82         "totalContactCount":1,
83         "completedContactCount":1,
84         "receivedDateUtc":"2019-02-25T17:03:00",
85         "status":"Completed",
86         "lastStatusDateUtc":"2019-03-11T23:06:49.167",
87         "deleteMethod":"Contact Key/ID"
88      },
89      {
90         "operationId":22543,
91         "totalContactCount":1,
92         "completedContactCount":1,
93         "receivedDateUtc":"2019-02-25T17:02:00",
94         "status":"Completed",
95         "lastStatusDateUtc":"2019-03-11T23:06:49.167",
96         "deleteMethod":"Contact Key/ID"
97      },
98      {
99         "operationId":22535,
100         "totalContactCount":1,
101         "completedContactCount":1,
102         "receivedDateUtc":"2019-02-25T16:00:00",
103         "status":"Completed",
104         "lastStatusDateUtc":"2019-03-11T22:06:33.593",
105         "deleteMethod":"Contact Key/ID"
106      },
107      {
108         "operationId":22534,
109         "totalContactCount":1,
110         "completedContactCount":1,
111         "receivedDateUtc":"2019-02-25T15:59:00",
112         "status":"Completed",
113         "lastStatusDateUtc":"2019-03-11T22:06:33.593",
114         "deleteMethod":"Contact Key/ID"
115      },
116      {
117         "operationId":22409,
118         "totalContactCount":1,
119         "completedContactCount":1,
120         "receivedDateUtc":"2019-02-22T20:05:00",
121         "status":"Completed",
122         "lastStatusDateUtc":"2019-03-09T08:49:36.62",
123         "deleteMethod":"Contact Key/ID"
124      },
125      {
126         "operationId":22408,
127         "totalContactCount":1,
128         "completedContactCount":1,
129         "receivedDateUtc":"2019-02-22T20:04:00",
130         "status":"Completed",
131         "lastStatusDateUtc":"2019-03-09T08:49:36.62",
132         "deleteMethod":"Contact Key/ID"
133      },
134      {
135         "operationId":22313,
136         "totalContactCount":1,
137         "completedContactCount":1,
138         "receivedDateUtc":"2019-02-21T05:02:00",
139         "status":"Completed",
140         "lastStatusDateUtc":"2019-03-07T11:04:41.687",
141         "deleteMethod":"Contact Key/ID"
142      },
143      {
144         "operationId":22312,
145         "totalContactCount":1,
146         "completedContactCount":1,
147         "receivedDateUtc":"2019-02-21T05:01:00",
148         "status":"Completed",
149         "lastStatusDateUtc":"2019-03-07T11:04:41.687",
150         "deleteMethod":"Contact Key/ID"
151      }
152   ],
153   "requestServiceMessageID":"e1198208-6432-40fd-b5ae-172c9d9bc44a",
154   "responseDateTime":"2019-03-19T13:33:18.2141124-06:00",
155   "resultMessages":[
156
157   ],
158   "serviceMessageID":"ef7d833c-509f-4dbc-8f99-060aac3c0382"
159}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!