Получить отчет по импорту

/v2/Api/ImportReports GET

Отчет по импортам содержит в себе информацию об импортах в листы подписчиков, стоп-листы, черные списки или таблицы данных.

Формат данных

Параметры запроса:

Параметры	Тип	Описание
apiKey	string	Ваш API-key, необходимый для авторизации. Обязательный.
ReportType	string	Определяет тип получаемых данных. Обязательный. Может иметь следующие значения: Subscribers Suppressions Blacklist DataTables
StartDate	date	Необязательный. Оба параметра (StartDate, EndDate) задают период отчета. Если указан только один, они игнорируются. Формат — YYYY-MM-DD.
EndDate	date	См. StartDate
ScheduledTaskId	int	Необязательный. ID запланированной задачи, запустившей импорт.
ListId	int	Необязательный. ID листа подписчиков, в который выполнялся импорт. Работает с параметром ReportType = Subscribers. В противном случае игнорируется.
SuppressionListId	int	Необязательный. ID стоп-листа, в который выполнялся импорт. Работает с параметром ReportType = Suppressions. В противном случае игнорируется.

Примеры:

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

Ответ

Элементы тега Data в ответе:

Элемент/Атрибут	Тип	Описание
ImportReports	array[complex]	Array of ImportReport elements.

Элементы тега ImportReport в ответе:

Записи повторяющиеся в импорте.

Элемент/Атрибут	Тип	Описание
Id	int	ID импорта.
FileName	string	Имя импортируемого файла.
ImportDate	date	Дата выполнения импорта.
ImportType	string	Тип импорта.
ScheduledTaskId	int	Запланированная задача выполнившая импорт.
InvalidEntries	int	Неверные записи в файле импорта.
ValidEntries	int	Верные записи в файле импорта.
AddedEntries	int	Записи добавленные импортом.
UpdatedEntries	int	Записи обновленные импортом.
ReplacedEntries	int	Записи замененные импортом.
RepeatedEntries	int	ID.
SystemRejectedEntries	int	Записи отклоненные системой.
BlacklistedEmailEntries	int	Записи в черных листах (по емейлу).
BlacklistedDomainEntries	int	Записи в черных листах (по домену).
UnsubscribedEntries	int	Количество отписчиков.
ListName	string	Имя листа подписчиков или стоп-листа.
ListId	int	ID листа подписчиков или стоп-листа.
Status	string	Статус выполнения импорта.
ErrorDescription	string	Описание ошибки импорта в таблицы данных.

Элементы записей:

Параметры	Тип	Описание
Email	complex	Подробная статистика для ключа импорта электронной почты.
Phone	complex	Подробная статистика для ключа импорта телефона.
CustomSubscriberId	complex	Подробная статистика для ключа импорта CustomSubscriberId.

E-mail / Phone / CustomSubscriberId дочерние элементы:

Параметры	Тип	Описание
Valid	int	Количество найденных действительных записей.
Invalid	int	Количество недействительных записей.
Duplicated	int	Количество дублированных записей.
Empty	int	Количество найденных пустых записей.

Элемент подписки:

Параметры	Тип	Описание
Email	complex	Подробная статистика подписки на канал электронной почты.
Phone	complex	Подробная статистика подписки на телефонный канал.

Элемент дочерних элементов подписок:

Параметры	Тип	Описание
Added	int	Количество добавленных записей.
Updated	int	Количество обновленных записей.
Replaced	int	Количество замененных записей.
SystemRejected	int	Количество записей, отклоненных системой.
Blacklisted	int	Количество записей в черном списке.
Unsubscribed	int	Количество отписок.

Примеры

Запрос

GET 
https://api.esv2.com/v2/Api/ImportReports?ReportType=DataTables&apiKey= Ваш_API-ключ&StartDate=2014-10-31 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

OK ответ:

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_import.csv</FileName>
        <ImportDate>2014-10-31T07:21:33</ImportDate>
        <ImportType>Синхронизация таблицы с импортируемым файлом</ImportType>
        <ScheduledTaskId>3347</ScheduledTaskId>
        <AddedEntries>0</AddedEntries>
        <Status>Error</Status>
        <ErrorDescription>Нет таблиц с именем файла: test_import.csv</ErrorDescription>
      </ImportReport>
    </ImportReports>
  </Data>
</ApiResponse>

Запрос на импорт подписчиков:

 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 ответ:

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 
 

  
    
      
        125
        test_importu.csv
        2017-11-10T07:21:33
        29
        List_123
        Add new subscribers and update data of subscribers existing on the list
        Email
        41
        34
        3
        4
        0
        
            
                38
                0
                3
                0
            
            
                41
                0
                0
                0
            
            
                0
                0
                0
                0
            
        
        
            
                4
                33
                0
                0
                1
                0
            
            
                35
                0
                0
                1
                5
                0

Методы API - меню

Получить отчет по импортам

/v2/Api/ImportReports GET

Формат данных

Ответ

Примеры