{"id":3753,"date":"2023-08-31T08:28:40","date_gmt":"2023-08-31T07:28:40","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3753"},"modified":"2024-06-25T13:07:48","modified_gmt":"2024-06-25T12:07:48","slug":"get-export-progress","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/get-export-progress\/","title":{"rendered":"Get export progress"},"content":{"rendered":"\n

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

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

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

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

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/Exports\/23?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 export status. If export has completed, URL with file to download is also returned.<\/p>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Status<\/td>string<\/td>Status of scheduled export. One of below:
Queued – export is queued to execute, but has not started yet
InProgress – export is currently being processed
Completed – export has completed and file is available to download
Error – export has failed<\/td><\/tr>
DownloadUrl<\/td>string<\/td>URL address of file containing exported data. Returned only if Status=Completed.<\/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\/Exports\/23?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: Mon, 25 Nov 2013 18:50:13 GMT <\/span><\/span>\nContent-Length: 259<\/span><\/span>\n<\/span>\n<<\/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>Status<\/span>><\/span>Completed<\/span><\/<\/span>Status<\/span>><\/span><\/span>\n    <\/span><<\/span>DownloadUrl<\/span>><\/span>http:\/\/api.esv2.com\/v2\/Api\/DownloadFile\/23?apiKey=test_api_key1<\/span><\/<\/span>DownloadUrl<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3548,"menu_order":256,"template":"","format":"standard","emp-category":[],"class_list":["post-3753","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3753","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":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3753\/revisions"}],"predecessor-version":[{"id":11024,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3753\/revisions\/11024"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3548"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3753"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3753"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}