{"id":3649,"date":"2023-08-30T08:34:21","date_gmt":"2023-08-30T07:34:21","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&#038;p=3649"},"modified":"2024-03-19T13:23:26","modified_gmt":"2024-03-19T12:23:26","slug":"get-subscriber-import-progress","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/imports\/get-subscriber-import-progress\/","title":{"rendered":"Get subscriber import progress"},"content":{"rendered":"\n<h3 class=\"wp-block-heading\" id=\"h.mdtny2gnf0bm_l\"><strong>Request data format<\/strong><\/h3>\n\n\n\n<p>Request URL parameters:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Element\/attribute<\/th><th>Type<\/th><th>Notes<\/th><\/tr><\/thead><tbody><tr><td>apiKey<\/td><td>string<\/td><td>Your API key, required for authentication. Required.<\/td><\/tr><tr><td>ID<\/td><td>integer<\/td><td>Import ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>Example URL:<\/p>\n\n\n\n<div class=\"wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers\" data-code-block-pro-font-family=\"Code-Pro-JetBrains-Mono\" style=\"font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#A6ACCD;--cbp-line-number-width:8.4375px;line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)\"><span role=\"button\" tabindex=\"0\" data-code=\"https:\/\/api.esv2.com\/v2\/Api\/ImportToListTasks\/19?apiKey=test_api_key1\" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><svg  style=\"width:24px;height:24px\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\"><path class=\"with-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M4.5 12.75l6 6 9-13.5\"><\/path><path class=\"without-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6\"><\/path><\/svg><\/span><pre class=\"shiki material-theme-palenight\" style=\"background-color: #292D3E\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/ImportToListTasks\/19?apiKey=test_api_key1<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.gdt33pb1fevx_l\"><strong>Response<\/strong><\/h3>\n\n\n\n<p>Method returns an object describing the scheduled import and its execution history.<\/p>\n\n\n\n<p>Response Data element:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Element\/attribute<\/th><th>Type<\/th><th>Notes<\/th><\/tr><\/thead><tbody><tr><td>Name<\/td><td>string<\/td><td>Import task name.<\/td><\/tr><tr><td>List<\/td><td>string<\/td><td>Name of list subscribers will be imported to.<\/td><\/tr><tr><td>Url<\/td><td>string<\/td><td>URL address of file containing imported subscribers.<\/td><\/tr><tr><td>History<\/td><td>array[complex]<\/td><td>Array of Import elements describing import executions.*<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>*History may be empty if import was never executed.<\/p>\n\n\n\n<p>Import element children:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Element\/attribute<\/th><th>Type<\/th><th>Notes<\/th><\/tr><\/thead><tbody><tr><td>StartedAt<\/td><td>dateTime<\/td><td>Date of import start.<\/td><\/tr><tr><td>UpdatedAt<\/td><td>dateTime<\/td><td>Date of last import status change.<\/td><\/tr><tr><td>Status<\/td><td>string<\/td><td>Import status. One of: &#8220;Queued&#8221;, &#8220;InProgress&#8221;, &#8220;Completed&#8221;, &#8220;Error&#8221;,&nbsp;&#8220;Warning&#8221;.<\/td><\/tr><tr><td>Details<\/td><td>string<\/td><td>Additional information, e.g. error info if import failed.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.fueqs0uyslxp_l\"><strong>Examples<\/strong><\/h3>\n\n\n\n<p>Request:<\/p>\n\n\n\n<div class=\"wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers\" data-code-block-pro-font-family=\"Code-Pro-JetBrains-Mono\" style=\"font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#A6ACCD;--cbp-line-number-width:8.4375px;line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)\"><span role=\"button\" tabindex=\"0\" data-code=\"GET https:\/\/api.esv2.com\/v2\/Api\/ImportToListTasks\/19?apiKey=test_api_key1 HTTP\/1.1 \nAccept-Encoding: gzip,deflate \nUser-Agent: Jakarta Commons-HttpClient\/3.1 \nHost: api.esv2.com\" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><svg  style=\"width:24px;height:24px\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\"><path class=\"with-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M4.5 12.75l6 6 9-13.5\"><\/path><path class=\"without-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6\"><\/path><\/svg><\/span><pre class=\"shiki material-theme-palenight\" style=\"background-color: #292D3E\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color: #A6ACCD\">GET https:\/\/api.esv2.com\/v2\/Api\/ImportToListTasks\/19?apiKey=test_api_key1 HTTP\/1.1 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Accept-Encoding: gzip,deflate <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">User-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Host: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<p>Response:<\/p>\n\n\n\n<div class=\"wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers\" data-code-block-pro-font-family=\"Code-Pro-JetBrains-Mono\" style=\"font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#A6ACCD;--cbp-line-number-width:16.859375px;line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)\"><span role=\"button\" tabindex=\"0\" data-code=\"HTTP\/1.1 200 OK \nCache-Control: private \nContent-Type: text\/xml; charset=utf-8 \nServer: Microsoft-IIS\/7.5 \nX-AspNetMvc-Version: 3.0 \nX-AspNet-Version: 4.0.30319 \nX-Powered-By: ASP.NET \nDate: Thu, 05 Apr 2012 15:50:13 GMT \nContent-Length: 559  \n\n&lt;ApiResponse xmlns_xsd=&quot;http:\/\/www.w3.org\/2001\/XMLSchema&quot; xmlns_xsi=&quot;http:\/\/www.w3.org\/2001\/XMLSchema-instance&quot;&gt;\n   &lt;Data&gt;\n     &lt;Name&gt;API test import&lt;\/Name&gt;\n     &lt;List&gt;API test list&lt;\/List&gt;\n     &lt;Url&gt;ftp:\/\/ftp.expertsender.com\/Lists\/test.csv&lt;\/Url&gt;\n     &lt;History&gt;\n       &lt;Import&gt;\n         &lt;StartedAt&gt;2012-03-27T11:01:18&lt;\/StartedAt&gt;\n         &lt;UpdatedAt&gt;2012-03-27T11:01:27&lt;\/UpdatedAt&gt;\n         &lt;Status&gt;Completed&lt;\/Status&gt;\n         &lt;Details&gt;ftp:\/\/ftp.expertsender.com\/Lists\/test.csv&lt;\/Details&gt;\n       &lt;\/Import&gt;\n     &lt;\/History&gt;\n   &lt;\/Data&gt;\n&lt;\/ApiResponse&gt;\" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><svg  style=\"width:24px;height:24px\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\"><path class=\"with-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M4.5 12.75l6 6 9-13.5\"><\/path><path class=\"without-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6\"><\/path><\/svg><\/span><pre class=\"shiki material-theme-palenight\" style=\"background-color: #292D3E\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color: #A6ACCD\">HTTP\/1.1 200 OK <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Cache-Control: private <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Type: text\/xml; charset=utf-8 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Server: Microsoft-IIS\/7.5 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-AspNetMvc-Version: 3.0 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-AspNet-Version: 4.0.30319 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-Powered-By: ASP.NET <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Date: Thu, 05 Apr 2012 15:50:13 GMT <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Length: 559  <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">ApiResponse<\/span><span style=\"color: #89DDFF\"> <\/span><span style=\"color: #C792EA\">xmlns<\/span><span style=\"color: #89DDFF\">:<\/span><span style=\"color: #C792EA\">xsd<\/span><span style=\"color: #89DDFF\">=<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #C3E88D\">http:\/\/www.w3.org\/2001\/XMLSchema<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #89DDFF\"> <\/span><span style=\"color: #C792EA\">xmlns<\/span><span style=\"color: #89DDFF\">:<\/span><span style=\"color: #C792EA\">xsi<\/span><span style=\"color: #89DDFF\">=<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #C3E88D\">http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">   <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Data<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Name<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">API test import<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Name<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">List<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">API test list<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">List<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Url<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">ftp:\/\/ftp.expertsender.com\/Lists\/test.csv<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Url<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">History<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">       <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Import<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">         <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">StartedAt<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">2012-03-27T11:01:18<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">StartedAt<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">         <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">UpdatedAt<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">2012-03-27T11:01:27<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">UpdatedAt<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">         <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Status<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">Completed<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Status<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">         <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Details<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">ftp:\/\/ftp.expertsender.com\/Lists\/test.csv<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Details<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">       <\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Import<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">History<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">   <\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Data<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">ApiResponse<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3682,"menu_order":288,"template":"","format":"standard","emp-category":[],"class_list":["post-3649","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3649","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\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3649\/revisions"}],"predecessor-version":[{"id":8811,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3649\/revisions\/8811"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3682"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3649"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3649"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}