Skip to content

Get export progress

Request data format

Request URL parameters:

ParameterTypeNotes
apiKeystringYour API key, required for authentication. Required.
IDintegerExport ID. Required as a part of address (not GET parameter). See example below.

Example URL:

https://api.esv2.com/v2/Api/Exports/23?apiKey=test_api_key1

Response

Method returns an object describing the scheduled export status. If export has completed, URL with file to download is also returned.

Response Data element:

Element/attributeTypeNotes
StatusstringStatus of scheduled export. One of below:
Queued – export is queued to execute, but has not started yetInProgress – export is currently being processedCompleted – export has completed and file is available to downloadError – export has failed
DownloadUrlstringURL address of file containing exported data. Returned only if Status=Completed.

Examples

Request:

GET https://api.esv2.com/v2/Api/Exports/23?apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Response:

HTTP/1.1 200 OK 
Cache-Control: private
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 3.0 
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Mon, 25 Nov 2013 18:50:13 GMT 
Content-Length: 259

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Status>Completed</Status>
    <DownloadUrl>http://api.esv2.com/v2/Api/DownloadFile/23?apiKey=test_api_key1</DownloadUrl>
  </Data>
</ApiResponse>
On this page
To top