campaigns.get – v1.0
campaigns.get (int campaign_id, string status, int list_id, int limit, string type)
Получаем список рассылок пользователя
Категория метода
campaigns
Параметры
campaign_id |
int опционально - id запрашиваемой рассылки |
status |
string опционально - {MODERATING,DRAFT,SCHEDULE,CREATED,PROCESSING,SENT,DELIVERED,BLOCKED,BLOCKED-SPAM,NEED-FIX,DELETED,
WAITING,PAUSED} - статус рассылки |
list_id |
int опционально - фильтр рассылок по адресным базам |
limit |
int опционально - фильтр количества возвращаемых рассылок (начиная от самой новой) |
type |
string опционально - {online_builder, html, plain_text} - тип кампании (онлайн-редактор, html-шаблон, plain_text) |
Возвращаемые значения (значения data)
array
Массив подписчиков с параметрами.
id | id рассылки |
type | тип рассылки. возможные значения: online_builder, html. |
status | {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED} - статус рассылки |
name | название рассылки |
list_id | адресная база, по котором производится рассылка |
subject | заголовок письма |
from_name | от кого письмо? |
from_email | обратный адрес |
personalizeToEmail | {on/off} - включить/выключить персонализацию в поле "Кому:" |
to_email | персонализация в поле "Кому:" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%] |
track_opens | {Y,N} - следить за открыванием |
track_clicks | {Y,N} - отслеживать клики |
analytics | {Y,N} - если {Y}, система сама добавит параметры Google Analytics™(utm_source=dclite, utm_medium=email, utm_campaign=[ID компании], utm_content=[текущая дата], utm_term=[название компании]) для отслеживания всех URLs. Если {N}, вы сами можете задать любые параметры через analytics_tag |
analytics_tag | Если [analytics:N], добавление своих параметров для отслеживания всех URLs, строка вида: a=1&b=2&c=3 |
html | код html-версии письма |
css | css-код html-версии письма в случае использования онлайн-редактора |
plain_text | текстовая версия письма |
delivery_time | время отправки рассылки |
auto | статус для авторассылки (0 - не активна, 1 - активна, 2 - в архиве) |
emails_sent | общее число отправленных писем в рамках этой рассылки |