Документация для версии v73

Получить историю одного профиля

Описание

Получить историю действий одного профиля в сообщениях.

URL-адрес

Метод: POST

https://example.com/api/v1.1/subscribers/history_get

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
list_id	Int	1	Да	Идентификатор базы данных
xxh	string	"0eb51aefd919f90a"	Нет, если есть matching	xxhash идентификатор профиля
matching	string	"email" "email_profile" "email_sub" "phone" "phone_sub" "profile_id" "push_sub" "custom" "custom_sub" "email_phone" "email_phone_sub"	Нет, если поиск по xxh	Режим поиска подписчика. По умолчанию – email. Для каждого типа матчинга в теле запроса необходимо передавать определенные поля. Подробнее об этих полях можно узнать здесь.
date_from	string	"2017-01-01"	Нет	Начало отчетного периода xxh.YYYYMMDD
date_to	string	"2017-12-31"	Нет	Конец отчетного периода xxh.YYYYMMDD

Пример запроса

JSON
XML

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "list_id": 20,
  "xxh": "0eb51aefd919f90a"
}

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <list_id>20</list_id>
  <xxh>0eb51aefd919f90a</xxh>
</xml>

Пример ответа

JSON
XML

    {
    "data": [
        {
            "xxh": "9202595093f237d4",
            "profile_id": "66f66973096b3b454bbbccec",
            "email": "example@example.com",
            "list_id": 66,
            "action": "send",
            "count": 1,
            "datetime": "2024-09-27T15:52:57.004Z",
            "message_id": 5,
            "campaign_id": 137,
            "event_id": "66f6aaa9da00a9db1c0b2683",
            "smid": "uBAhiRBRQhARg7y489hr5F2b2aXMJaztFS7vM7DE1NGJhZWM5",
            "campaign_name": "New astral campaign",
            "message_name": "New template",
            "subscription": {
                "resource_id": 5,
                "resource_name": "res1",
                "channel": "email",
                "email": "sub1@yandex.ru",
                "priority": 0,
                "status": "subscribed",
                "custom_fields": {
                    "_device_type": "other"
                },
                "cats": []
            },
            "channel": "email",
            "subscriptions": [
                {
                    "resource_id": 5,
                    "resource_name": "res1",
                    "channel": "email",
                    "email": "sub1@yandex.ru",
                    "priority": 0,
                    "status": "subscribed",
                    "custom_fields": {
                        "_device_type": "other"
                    },
                    "cats": []
                },
                {
                    "resource_id": 5,
                    "resource_name": "res1",
                    "channel": "email",
                    "email": "sub2@yandex.ru",
                    "priority": 0,
                    "status": "subscribed",
                    "custom_fields": {
                        "_device_type": "mob"
                    },
                    "cats": []
                }
            ]
        }
        ],
        "error": 0,
        "error_text": "Successful operation"
    }

<xml>
  <data>
        <item>
            <xxh>9202595093f237d4</xxh>
            <profile_id>66f66973096b3b454bbbccec</profile_id>
            <email>example@example.ru</email>
            <list_id>66</list_id>
            <action>send</action>
            <count>1</count>
            <datetime>2024-09-27T15:52:57.004Z</datetime>
            <message_id>5</message_id>
            <campaign_id>137</campaign_id>
            <event_id>66f6aaa9da00a9db1c0b2683</event_id>
            <smid>uBAhiRBRQhARg7y489hr5F2b2aXMJaztFS7vM7DE1NGJhZWM5</smid>
            <campaign_name>New astral campaign</campaign_name>
            <message_name>New template</message_name>
            <subscription>
                <resource_id>5</resource_id>
                <resource_name>res1</resource_name>
                <channel>email</channel>
                <email>sub1@yandex.ru</email>
                <priority>0</priority>
                <status>subscribed</status>
                <custom_fields>
                    <_device_type>other</_device_type>
                </custom_fields>
                <cats/>
            </subscription>
            <channel>email</channel>
            <subscriptions>
                <subscription>
                    <resource_id>5</resource_id>
                    <resource_name>res1</resource_name>
                    <channel>email</channel>
                    <email>sub1@yandex.ru</email>
                    <priority>0</priority>
                    <status>subscribed</status>
                    <custom_fields>
                        <_device_type>other</_device_type>
                    </custom_fields>
                    <cats/>
                </subscription>
                <subscription>
                    <resource_id>5</resource_id>
                    <resource_name>res1</resource_name>
                    <channel>email</channel>
                    <email>sub2@yandex.ru</email>
                    <priority>0</priority>
                    <status>subscribed</status>
                    <custom_fields>
                        <_device_type>mob</_device_type>
                    </custom_fields>
                    <cats/>
                </subscription>
            </subscriptions>
        </item>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
data	string	Массив полученных данных по событиям в истории профиля
data.xxh	string	xxhash идентификатор профиля
data.profile_id	string	Основной идентификатор профиля
data.email	string	Email-адрес профиля
data.list_id (db_id)	int	Идентификатор базы данных
data.action	string	Действие подписчика (Подробнее)
data.count	int	Количество действий, совершенных в эту секунду
data.datetime	string	Дата и время действия в формате RFC 3339 (ISO 8601)
data.message_id	int	Идентификатор шаблона сообщения Возвращает 0, если действие не предполагает использование шаблона.
data.campaign_id	int	Идентификатор кампании Возвращает 0, если действие не предполагает использование кампании.
data.event_id	string	Идентификатор события
data.smid	string	Уникальной идентификатор отправки в рамках кампании Возвращает пустую строку, если действие не предполагает отправку сообщения.
data.campaign_name	string	Название кампании Возвращает пустую строку, если действие не предполагает использование кампании.
data.message_name	string	Название шаблона сообщения Возвращает пустую строку, если действие не предполагает использование шаблона.
data.subscription	string	Объект с информацией о подписке, в рамках которой выполнялась отправка
data.channel	string	Канал коммуникации, в рамках которого зарегистрировано событие. Возвращает пустую строку, если канал не задействован.
data.subscriptions	array of objects	Все подписки профиля. Для формата CSV будет представлены в виде JSON строки.
error	int	Код ошибки
error_text	string	Текст ошибки

События в истории профиля (action)

События Email канала
send	Email отправлен
deliv	Email доставлен
undeliv	Email не доставлен
open	Email открыт
read	Email прочитан. Сообщение открыто пользователем в течении 8 и более секунд
click	Клик в Email. Событие регистрируется при переходе по ссылке в письме. Для каждой ссылки регистрируется свое событие клика, т.е. если профиль перейдет по двум разным ссылкам в письме, будут зарегистрированы 2 события клика.
confirm	Переход по ссылке подтверждения подписки в Email письме (confirm-link)
subscribe_email	Подписан на Email канал ресурса
unsubscribe_email	Отписан от Email канала ресурса
reply	Получен ответ на Email-письмо
complain	Получен статус Жалобщик
hbounce	Получен статус Hardbounced
События SMS канала
send_sms	SMS сообщение отправлено в шлюз для доставки подписчику
deliv_sms	SMS сообщение доставлено
undeliv_sms	SMS сообщение не доставлено
click_sms	Неуникальный клик по ссылке в SMS сообщении
subscribe_sms	Подписан на SMS канал ресурса
unsubscribe_sms	Отписан от SMS канала ресурса
События Push канала
send_push	Push отправлен
deliv_push	Push доставлен
open_push	Неуникальное открытие push сообщения
click_push	Клик в Push
undeliv_push	Push сообщение не доставлено
subscribe_push	Подписан на Push канал ресурса
unsubscribe_push	Отписан от Push канала ресурса
События Telegram Bot канала
telegram_bot_send	В канале Telegram Bot произошло событие Telegram bot отправка
telegram_bot_deliv	В канале Telegram Bot произошло событие Telegram bot доставка
telegram_bot_undeliv	В канале Telegram Bot произошло событие Telegram bot недоставка
telegram_bot_click	В канале Telegram Bot произошло событие Telegram bot клик
telegram_bot_subscribe	В канале Telegram Bot произошло событие Telegram bot подписка
*События WhatsApp-канала**
whatsapp_send	Сообщение отправлено для доставки подписчику в whatsapp чат
whatsapp_deliv	Сообщение доставлено в whatsapp чат
whatsapp_undeliv	Сообщение не доставлено в whatsapp чат
whatsapp_click	Неуникальный клик по ссылке в сообщении в whatsapp чате
whatsapp_read	Сообщение прочитано пользователем
whatsapp_subscribe	В канале whatsapp произошло событие Whatsapp подписка
События Viber канала
viber_send	Сообщение отправлено для доставки подписчику в Viber чат
viber_deliv	Сообщение доставлено получателю
viber_undeliv	Сообщение не доставлено, т.к. отклонено Viber или Devino.Online
viber_click	Переход по ссылке в сообщении. Если получатель несколько раз кликнул по одной и той же ссылке, фиксируется каждое событие клика.
viber_read	Сообщение прочитано пользователем
viber_subscribe	В канале Viber произошло событие Viber подписка
События для всех каналов
offence	Сообщение не отправлено из-за ограничений политики отправки
suppress	Сообщение не было отправлено кампанией, т.к. профиль находится в стоп-списке
События импорта профилей подписчиков
import_manual	Профиль создан вручную
import_api	Профиль создан API-импортом
import_file	Профиль создан импортом из файла
import_form	Профиль создан импортом из формы
import_push	Профиль создан в результате push-импорта
import_popup	Профиль создан импортом через попап
События отписки
unsub_api	Подписчик отписан от рассылок через API
unsub_manual	Отписан вручную (глобальный статус профиля изменен на "Отписан")
События пикселя
pixel_open	Достигнута цель
События, связанные с промокодами
promocode_attach	Привязан промокод
promocode_detach	Отвязан промокод
promocode_activate	Активирован промокод
События сегментов
segs_add	Вошёл в статический сегмент
segs_remove	Вышел из статического сегмента
События связей между профилями
rel_attach	Профиль получает связь с другим профилей
rel_detach	Профиль теряет связь с другим профилем
rel_strengthen	Увеличивается вес связи между профилями
События формы
form_load	Форма загружена
form_page_show	Страница формы загружена
form_post	Форма заполнена и отправлена
form_abandon	Форма брошена. Профиль загружает страницу с формой и не закрывает её в течение часа, при этом не отправляя форму
form_bounce	Ошибка при заполнении формы (попытка повторного заполнения, технические проблемы и др.)

*Организация Meta, которой принадлежат продукты Instagram, Facebook и WhatsApp, признана экстремистской и запрещена на территории РФ.

Описание​

URL-адрес​

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

Пример запроса​

Пример ответа​

Возвращаемые параметры​

События в истории профиля (action)​