Экспорт сегментов и списков

/v2/Api/Exports POST

Этот метод позволяет экспортировать списки и сегменты. Данные экспортируются в CSV формате.

Статус экспорта можно получить через GET-запрос. Когда экспорт выполнен, запрос возвращает ссылку на готовый для скачивания файл.

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

Данные для планирования экспорта.

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

Параметр	Тип	Описание
Type	string	Тип экспорта. Обязательный. Допустимые значения: List - экспорт списка подписчиков Segment - экспорт сегмента подписчиков
ListId	integer	ID экспортируемого списка подписчиков. Обязательный, когда Type=List. В противном случае игнорируется.
SegmentId	integer	ID экспортируемого сегмента подписчиков. Обязательный, когда Type=Segment. В противном случае игнорируется.
Fields	complex	Список системных полей, который будет экспортирован (т.е. Email, Firstname, Vendor и т.д.). По крайней мере одно системное или дополнительное поле должно быть выбрано. Таблица со всеми доступными значениями ниже.
Properties	complex	Список дополнительных полей. Дополнительные поля идентифицируются по ID.

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

Элемент/атрибут	Тип	Описание
(Field element content)	string	Название системного поля.

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

Элемент/атрибут	Тип	Описание
(Property element content)	int	ID дополнительного поля.

Доступные для экспорта системные поля:

Название	Описание
FirstName	Имя подписчика.
LastName	Фамилия подписчика.
Email	Емейл подписчика.
EmailMd5	MD5-хэш емейла подписчика.
IP	IP адрес подписчика используемый для подписки.
Id	Уникальный идентификатор подписчика.
Vendor	Источник траффика подписчика.
TrackingCode	Трекинговый код подписчика.
GeoCountry	Страна подписчика. Определяется по IP адресу, через который подписчик отрывал последнее сообщение.
GeoState	Регион/штат подписчика.
GeoCity	Город подписчика.
GeoZipCode	ZIP/индекс подписчика.
LastActivity	Дата последней активности подписчика (клик, открытие, посещение страницы настроек и т.п.).
LastMessage	Дата последнего отправленного подписчику письма.
SubscriptionDate	Дата подписки на лист. Если импортируется сегмент, будет возвращена самая ранняя дата подписки.

Запрос

Метод возвращает ID запланированного экспорта. ID можно использовать для получения статуса экспорта через GET-запрос.

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

Элемент/атрибут	Тип	Описание
(Data element content)	int	ID запланированного экспорта.

Примеры

Простой экспорт списка

Запрос:

POST https://api.esv2.com/v2/Api/Exports HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 411 


<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <ApiKey>Ваш_API_ключ</ApiKey>
  <Data>
    <Type>List</Type>
    <ListId>11</ListId>
    <Fields>
      <Field>Email</Field>
      <Field>FirstName</Field>
      <Field>LastName</Field>
    </Fields>
  </Data>
</ApiRequest>

Экспорт сегмента с дополнительными свойствами

Запрос:

POST https://api.esv2.com/v2/Api/Exports HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 411 


<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <ApiKey>Ваш_API_ключ</ApiKey>
  <Data>
    <Type>Segment</Type>
    <SegmentId>93</SegmentId>
    <Fields>
      <Field>Email</Field>
      <Field>FirstName</Field>
      <Field>LastName</Field>
    </Fields>
    <Properties>
      <Property>5</Property>
      <Property>12</Property>
    </Properties>
  </Data>
</ApiRequest>

Ответ:

HTTP/1.1 201 Created 
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 16:40:14 GMT 
Content-Length: 147 
 
 
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>12</Data>
</ApiResponse>

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