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

/v2/Api/SnoozedSubscribers GET

Этот метод позволяет получить список подписчиков, которые приостановили свою подписку. Эти данные можно отфильтровать по Id листа, и по диапазону дат.

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

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

Параметр Тип Описание
apiKey string Ваш API-ключ, необходимый для авторизации. Обязательный.
ListIds int(CSV) Id листов. Необязательно. Если указаны, то будут возвращены подписчики только из указанных листов
startDate date Дата начала. Необязательный. Если указано, то подписчики, у которых дата приостановки подписки истекает до этой даты, возвращены не будут. Может быть использована с endDate, чтобы задать период времени. Формат - YYYY-MM-DD.
endDate date См. startDate

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

Примеры запросов: 

https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=Ваш_API_ключ
https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=Ваш_API_ключ&listIds=1,3,16 
https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=Ваш_API_ключ&startDate=2014-03-01&endDate=2014-03-10

Ответ

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

Параметр Тип Описание
SnoozedSubscribersList array[complex] Массив элементов списков

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

Элемент/атрибут Тип Описание
Email string Email приостановленного подписчика
listId int Идентификатор листа, в котором находится приостановленный подписчик
SnoozedUntil dateTime Дата и время, когда заканчивается приостановка подписки (UTC)

Примеры

Запрос: 

GET https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=Ваш_API_ключ HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
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
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.1
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 05 Mar 2014 12:16:49 GMT
Content-Length: 591

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <SnoozedSubscribers>
      <SnoozedSubscriber>
        <Email>testsnoozed1@test123.com</Email>
        <ListId>22</ListId>
        <SnoozedUntil>2014-03-05T11:13:04Z</SnoozedUntil>
      </SnoozedSubscriber>
      <SnoozedSubscriber>
        <Email>testsnoozed2@test123.com</Email>
        <ListId>101</ListId>
        <SnoozedUntil>2014-04-28T15:09:44Z</SnoozedUntil>
      </SnoozedSubscriber>
    </SnoozedSubscribers>
  </Data>
</ApiResponse>