Embedded Files
API Documentation V2
ImportReports collection allows retrieving information about imports to subscribers list, suppressions list, blacklist or data tables.
Request data format
Request data format
Request URL parameters:
Example:
https://api.esv2.com/v2/Api/ImportReports?ReportType=Suppressions&apiKey=YOUR_API_KEY_HERE&StartDate=2017-10-27
https://api.esv2.com/v2/Api/ImportReports?ReportType=Subscribers&apiKey=YOUR_API_KEY_HERE&ScheduledTaskID=3344&StartDate=2017-10-26&EndDate=2017-10-28&ListId=7459
Response
Response
Response Data element:
ImportReport element children:
Entries element:
Email/Phone/CustomSubscriberId elements' children:
Subscriptions element:
Subscriptions' element children:
Example
Example
DataTables import
Request:
GET
https://api.esv2.com/v2/Api/ImportReports?ReportType=DataTables&apiKey= YOUR_API_KEY_HERE&StartDate=2017-10-31 HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
OK response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=znbbf255rwgtzketrup04q55; path=/; HttpOnly
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 31 Oct 2014 11:05:25 GMT
Content-Length: 651
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>
<ImportReports>
<ImportReport>
<Id>137</Id>
<FileName>test_importu.csv</FileName>
<ImportDate>2014-10-31T07:21:33</ImportDate>
<FinishedDate>2014-10-31T07:35:26.283</FinishedDate>
<ImportType>Synchronize table with import file</ImportType>
<ScheduledTaskId>3347</ScheduledTaskId>
<AddedEntries>0</AddedEntries>
<Status>Error</Status>
<ErrorDescription>Nie ma tabeli o podanej nazwie pliku: test_importu.csv</ErrorDescription>
</ImportReport>
</ImportReports>
</Data>
</ApiResponse>
Subscribers import
Request:
GET
https://api.esv2.com/v2/Api/ImportReports?ReportType=Subscribers&apiKey= YOUR_API_KEY_HERE&StartDate=2017-10-31 HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
OK response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=znbbf255rwgtzketrup04q55; path=/; HttpOnly
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 31 Oct 2014 11:05:25 GMT
Content-Length: 651
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>
<ImportReports>
<ImportReport>
<Id>125</Id>
<FileName>test_importu.csv</FileName>
<ImportDate>2017-11-10T07:21:33</ImportDate>
<FinishedDate>2017-11-10T07:35:26.283</FinishedDate>
<ListId>29</ListId>
<ListName>List_123</ListName>
<ImportType>Add new subscribers and update data of subscribers existing on the list</ImportType>
<MatchingMode>Email</MatchingMode>
<TotalRows>41</TotalRows>
<ValidRows>34</ValidRows>
<InvalidRows>3</InvalidRows>
<ConflictingRecords>4</ConflictingRecords>
<DuplicatedRows>0</DuplicatedRows>
<Entries>
<Email>
<Valid>38</Valid>
<Duplicated>0</Duplicated>
<Invalid>3</Invalid>
<Empty>0</Empty>
</Email>
<Phone>
<Valid>41</Valid>
<Duplicated>0</Duplicated>
<Invalid>0</Invalid>
<Empty>0</Empty>
</Phone>
<CustomSubscriberId>
<Valid>0</Valid>
<Duplicated>0</Duplicated>
<Invalid>0</Invalid>
<Empty>0</Empty>
</CustomSubscriberId>
</Entries>
<Subscriptions>
<Email>
<Added>4</Added>
<Updated>33</Updated>
<Replaced>0</Replaced>
<SystemRejected>0</SystemRejected>
<Blacklisted>1</Blacklisted>
<Unsubscribed>0</Unsubscribed>
</Email>
<Phone>
<Added>35</Added>
<Updated>0</Updated>
<Replaced>0</Replaced>
<SystemRejected>1</SystemRejected>
<Blacklisted>5</Blacklisted>
<Unsubscribed>0</Unsubscribed>
</Phone>
</Subscriptions>
</ImportReport>
</ImportReports>
</Data>
</ApiResponse>
Report abuse