{"id":10926,"date":"2024-06-25T10:44:18","date_gmt":"2024-06-25T09:44:18","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=10926"},"modified":"2024-06-25T12:21:33","modified_gmt":"2024-06-25T11:21:33","slug":"get-suppression-list-import-progress","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/get-suppression-list-import-progress\/","title":{"rendered":"Get suppression list import progress"},"content":{"rendered":"\n

Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
ID<\/td>integer<\/td>Import ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example URL:\u00a0\u00a0<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/ImportToSuppressionListTasks\/19?apiKey=test_api_key1<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Method returns an object describing the scheduled import and its execution history.<\/p>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Name<\/td>string<\/td>Import task name.<\/td><\/tr>
List<\/td>string<\/td>Name of suppression list for imported records.<\/td><\/tr>
Url<\/td>string<\/td>URL address of file containing records to import.<\/td><\/tr>
History<\/td>array[complex]<\/td>Array of Import elements describing import executions.*<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
*History may be empty if import was never executed.<\/p>\n\n\n\n
Import element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
StartedAt<\/td>dateTime<\/td>Date of import start.<\/td><\/tr>
UpdatedAt<\/td>dateTime<\/td>Date of last import status change.<\/td><\/tr>
Status<\/td>string<\/td>Import status. One of: “Queued”, “InProgress”, “Completed”, “Error”,\u00a0“Warning”.<\/td><\/tr>
Details<\/td>string<\/td>Additional information, e.g. error info if import failed.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/ImportToSuppressionListTasks\/19?apiKey=test_api_key1 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nX-AspNetMvc-Version: 3.0 <\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Thu, 05 Apr 2012 15:50:13 GMT <\/span><\/span>\nContent-Length: 559   <\/span><\/span>\n<\/span>\n <\/span><<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>API test import<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>List<\/span>><\/span>API test suppression list<\/span><\/<\/span>List<\/span>><\/span><\/span>\n     <\/span><<\/span>Url<\/span>><\/span>ftp:\/\/ftp.expertsender.com\/Lists\/test.csv<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n     <\/span><<\/span>History<\/span>><\/span><\/span>\n       <\/span><<\/span>Import<\/span>><\/span><\/span>\n         <\/span><<\/span>StartedAt<\/span>><\/span>2012-03-27T11:01:18<\/span><\/<\/span>StartedAt<\/span>><\/span><\/span>\n         <\/span><<\/span>UpdatedAt<\/span>><\/span>2012-03-27T11:01:27<\/span><\/<\/span>UpdatedAt<\/span>><\/span><\/span>\n         <\/span><<\/span>Status<\/span>><\/span>Completed<\/span><\/<\/span>Status<\/span>><\/span><\/span>\n         <\/span><<\/span>Details<\/span>><\/span>ftp:\/\/ftp.expertsender.com\/Lists\/test.csv<\/span><\/<\/span>Details<\/span>><\/span><\/span>\n       <\/span><\/<\/span>Import<\/span>><\/span><\/span>\n     <\/span><\/<\/span>History<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":13,"featured_media":0,"parent":3551,"menu_order":0,"template":"","format":"standard","emp-category":[],"class_list":["post-10926","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10926","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/13"}],"version-history":[{"count":1,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10926\/revisions"}],"predecessor-version":[{"id":10927,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10926\/revisions\/10927"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=10926"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=10926"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}