Получить список удаленных подписчиков

/v2/Api/RemovedSubscribers GET

Возвращает список подписчиков, которые были удалены из листа по любым причинам. Можно передать любую комбинацию причин удаления, временного промежутка и ID листа, чтобы получить только интересующие данные.

Формат запроса

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

Элемент	Тип	Описание
apiKey	string	Ваш API-ключ, необходимый для авторизации. Обязательный.
listIds	int (CSV)	Идентификаторы листов. Необязательный. Если определен, то будут возвращены только удаленные подписчики из этих листов. Если не определен, то вернутся из всех листов. Для определения нескольких листов необходимо использовать запятую, например, 12, 34, 56, 789.
removeTypes	string (CSV)	Тип удаления подписчика. Необязательный. Если определен, то вернутся только удаленные с этими причинами. Иначе вернутся все удаленные. Для передачи нескольких типов необходимо использовать запятую, например: OptOutLink, Ui. Смотрите ниже список всех типов.
startDate	date	Начальная дата. Необязательное. Если определено, то удаленные до этой даты не будут возвращены. Может использоваться с endDate. Формат — YYYY-MM-DD.
endDate	date	Дата окончания. Формат смотрите в startDate.
option	option	Необязательный. Используется для получения дополнительной информации подписчика. Принимает значения: Customs - возвращает все дополнительные и некоторые системные поля подписчика.

Обязательный параметр только apiKey. Если вы пропустите остальные параметры, то вы получите список подписчиков, удаленных по любой причине из всех листов с момента создания вашего субаккаунта.

Список removeTypes:

Значение	Описание
OptOutLink	Подписчики, кликнувшие ссылку «Отписаться» в письме.
Ui	Удаленные вручную через панель ExpertSender.
BounceLimit	Удалены, потому что достигли лимита мягких ошибок.
Complaint	Удалены, потому что пожаловались на спам
UserUnknown	Удалены, потому что емейл-сервер вернул UserUnknown (емейл-адрес не существует).
Api	Удалены через API.

Примеры:

https://api.esv2.com/v2/Api/RemovedSubscribers?apiKey=Ваш_API_ключ
https://api.esv2.com/v2/Api/RemovedSubscribers?apiKey=Ваш_API_ключ&listIds=1,3,16 
https://api.esv2.com/v2/Api/RemovedSubscribers?apiKey=Ваш_API_ключ&listIds=1&startDate=2010-05-01&endDate=2010-05-10 
https://api.esv2.com/v2/Api/RemovedSubscribers?apiKey=Ваш_API_ключ&removeTypes=OptOutLink,Complaint,Ui

Ответы

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

Элемент/атрибут	Тип	Описание
RemovedSubscribers	array[complex]	Массив элементов RemovedSubscriber.

Элементы тега RemovedSubscriber:

Элемент/атрибут	Тип	Описание
Email	string	Емейл удаленного подписчика.
ListId	int	ID листа, из которого удалился подписчик
UnsubscribedOn	dateTime	Дата ивремя удаления (по UTC).

Дополнительные элементы возвращенные с опцией Customs:

Элемент/атрибут	Тип	Описание
Id	int	ID подписчика.
Firstname	string	Имя подписчика.
Lastname	string	Фамилия подписчика.
Ip	string	IP адрес подписчика.
Vendor	string	Код источника трафика подписчика.
Properties	array[complex]	Массив дополнительных полей подписчика.

Элементы тега Properties:

Элемент/атрибут	Тип	Описание
Id	integer	ID поля данных.
Source	string	Информация об источнике значения дополнительного поля. Смотрите ниже все возможные источники данных для дополнительных полей.
DateTimeValue	datetime	Значение. Только для дополнительных полей с типом date и datetime.
IntValue	integer	Значение. Только для дополнительных полей с числовым типом.
StringValue	string	Значение. Только для дополнительных полей со строковым типом.
DecimalValue	decimal	Значение. Только для дополнительных полей с типом валюта.
Type	string	Тип данных. смотрите ниже все возможные типы данных.
FriendlyName	string	Имя дополнительного поля подписчика.
Description	string	Описание текущего дополнительного поля.
Name	string	Имя дополнительного поля.
DefaultStringValue	string	Значение дополнительного поля по умолчанию. Только для дополнительных полей строкового типа.
DefaultIntValue	integer	Значение дополнительного поля по умолчанию. Только для дополнительных полей числового типа.
DefaultDateTimeValue	datetime	Значение дополнительного поля по умолчанию. Только для дополнительных полей типа дата и дата и время.
DefaultDecimalValue	decimal	Значение дополнительного поля по умолчанию. Только для дополнительных полей с типом валюта.

Источники дополнительных полей:

Имя	Описание
Web	Дополнительное поле было добавлено или изменено через веб-форму подписки.
Panel	Дополнительное поле было добавлено или изменено вручную через интерфейс ExpertSender.
Import	Дополнительное поле было добавлено или изменено через импорт.
Api	Дополнительное поле было добавлено или изменено через ExpertSender REST API.
PrefCenter	Подписчик добавил или изменил дополнительное поле в менеджере подписки.

Типы данных:

Имя	Описание
Text	Текстовое дополнительное поле.
Number	Целое число, например, 0 или 123.
Money	Число с десятичным разделителем, например, 10,99.
Url	Url.
Date	Дата, например, 2011-01-01.
Datetime	Дата и время, например, 2011-01-01 12:00:00.
SingleSelect	Список с возможностью выбрать из него только одно значение.
Boolean	True/false.

Примеры

Запрос:

GET http://api.esv2.com/v2/Api/RemovedSubscribers?startDate=2011-02-01&apiKey=Ваш_API_ключ&listIds=1&endDate=2011-09-16 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Ответ:

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: Thu, 17 May 2012 13:15:26 GMT 
Content-Length: 535 
 
 
 <ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Data>
     <RemovedSubscribers>
       <RemovedSubscriber>
         <Email>test123@yahoo.com</Email>
         <ListId>1</ListId>
         <UnsubscribedOn>2011-07-21T00:00:00Z</UnsubscribedOn>
       </RemovedSubscriber>
       <RemovedSubscriber>
         <Email>test456@yahoo.com</Email>
         <ListId>1</ListId>
         <UnsubscribedOn>2011-09-14T11:37:20Z</UnsubscribedOn>
       </RemovedSubscriber>
   </Data>
 </ApiResponse>

Запрос с опцией Customs:

Запрос:

GET http://api.esv2.com/v2/Api/RemovedSubscribers?apiKey=Ваш_API_ключ&startDate=2016-05-01&option=Customs HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Ответ:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Date: Fri, 15 Jul 2016 10:36:47 GMT
Content-Length: 2866


  
    
      
        grzegorz.tylak@expertsender.com
        1194
        2016-06-21T08:33:34Z
        
          
            1
            NotSet
            abc
            Text
            tekst
            tekstowa cecha xxx
            tekst
            abc
          
          
            9
            NotSet
            1
            Boolean
            testowy boolean "fifi"
            to jest test
            test_bool
            1
          
          
            23
            NotSet
            3.14
            Money
            kwota
            
            kwota
            3.14
          
        
        4238630

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