get
Получение подписчиков.
Необязательные параметры:
| Параметр | Описание |
|---|---|
| Параметр | Описание |
| count (int) | количество элементов, информацию о которых нужно вернуть максимум: |
| offset_id (string) | смещение, которое необходимо передавать для выборки следующего множества (берется из ответа) пример: 5c6992770b295058e641bb86 |
| vk_user_id или tg_user_id (array) | идентификаторы пользователей ВКонтакте или Telegram соответственно пример: [1,2] |
| subscription_id (array) | идентификаторы групп подписчиков (0 - без группы) пример: [0,123] |
| ignore_subscription_id (array) | идентификаторы групп, подписчиков которых нужно исключить из выборки (0 - без группы) пример: [0,123] |
| delivery_id (array) | идентификаторы рассылок которые получили подписчики пример: [123] |
| ignore_delivery_id (array) | идентификаторы рассылок которые не получили подписчики пример: [123] |
| error_delivery_id (array) | идентификаторы рассылок, при отправке которых пользователю произошла ошибка при доставке пример: [123] |
| read_delivery_id (array) | идентификаторы рассылок, которые прочитали пользователи пример: [123] |
| ignore_read_delivery_id (array) | идентификаторы рассылок, которые не прочитали пользователи пример: [123] |
| away_delivery_id (array) | идентификаторы рассылок, в которых пользователи перешли по ссылкам пример: [123] |
| ignore_away_delivery_id (array) | идентификаторы рассылок, в которых пользователи не перешли по ссылкам пример: [123] |
| utm_id (array) | идентификаторы меток Senler пример: [0,123] |
| source (array) | источник подписки
|
| utm_source (array) | источник кампании пример: ['vk'] |
| utm_medium (array) | тип трафика пример: ['cpc'] |
| utm_campaign (array) | название кампании пример: ['skidka_po_karte'] |
| utm_content (array) | идентификатор объявления пример: ['banner'] |
| utm_term (array) | ключевое слово пример: ['заказать стул онлайн'] |
| date_subscription_from (string) | дата и время, с которой подписались на группу подписчиков формат: d.m.Y H:i:s пример: 26.11.2018 10:00:00 |
| date_subscription_to (string) | дата и время, до которой подписались на группу подписчиков формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_first_from (string) | дата и время, с которой произошла первая подписка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_first_to (string) | дата и время, до которой произошла первая подписка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_delivery_from (string) | дата и время, с которой получена рассылка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_delivery_to (string) | дата и время, до которой получена рассылка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_first_delivery_from (string) | дата и время, с которой была получена первая рассылка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_first_delivery_to (string) | дата и время, до которой была получена первая рассылка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_last_delivery_from (string) | дата и время, с которой была получена последняя рассылка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_last_delivery_to (string) | дата и время, до которой была получена последняя рассылка формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_away_from (string) | дата и время, с которой был переход по ссылка в рассылке формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| date_away_to (string) | дата и время, до которой был переход по ссылка в рассылке формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| bot_id (int) | идентификатор бота в котором состоят подписчики пример: 1 |
| step_id (array) | идентификаторы шагов в боте, который передан в параметре bot_id пример: ['5c6992770b295058e641bb86'] |
| ignore_bot_id (int) | идентификатор бота, участников которого нужно исключить из выборки пример: 1 |
| ignore_step_id (array) | идентификаторы шагов в боте, участников которого нужно исключить из выборки. Принимаются шаги бота, который передан в параметре bot_id пример: ['5c6992770b295058e641bb86'] |
| lead_status (int) | фильтрация подписчиков по статусу. Принимает значения 1 или 2, где 1 - Активный, а 2 - Неактивный. |
| var_name (string) | имя переменной. Пример: |
| var_value (string) | значение переменной. Пример: |
Ответ:
| Параметр | Описание |
|---|---|
success |
|
offset_id | смещение, которое необходимо передавать для выборки следующего множества |
items | список подписчиков |
Структура элемента массива с подписчиками (items):
| Параметры | Описание |
|---|---|
| Параметры | Описание |
| date (string) | дата первой подписки формат: d.m.Y H:i:s пример: 27.11.2018 10:00:00 |
| vk_user_id или tg_user_id (int) | идентификатор подписчика ВКонтакте или Telegram соответственно пример: 1 |
| ignore (int) | если пользователь в черном списке - значение "1", иначе "0" пример: 0 |
| first_name (string) | имя подписчика пример: Иван |
| last_name (string) | фамилия подписчика пример: Иванов |
| photo (string) | ссылка на изображение подписчика пример: https://sun6-6.userapi.com |
| subscriptions (array) | список подписок на группы |
| utms (array) | список меток Senler и utm-меток |
| vars (array) | переменные и их значения. |
Структура элемента массива с подписками на группу (subscriptions):
| Параметры | Описание |
|---|---|
date | Дата подписки |
subscription_id | Идентификатор группы подписчиков |
source | Источник подписки
|
Структура элемента массива метками (utms):
| Параметр | Описание |
|---|---|
utm_id | идентификатор меток Senler |
utm_source | источник кампании |
utm_medium | тип трафика |
utm_campaign | название кампании |
utm_content | идентификатор объявления |
utm_term | ключевое слово |