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

Описание

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

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

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

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

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

{
  "data": [
    {
      "action": "click",
      "count": 1,
      "datetime": "2017-04-05T07:48:44Z",
      "email": "john@example.com",
      "list_id": 1,
      "message_id": 1,
      "xxh": "0eb51aefd919f90a",
      "campaign_id": 1
    },
    {
      "action": "open",
      "count": 1,
      "datetime": "2017-04-05T07:48:44Z",
      "email": "john@example.com",
      "list_id": 1,
      "message_id": 1,
      "xxh": "a81879594020ac07",
      "campaign_id": 1
    },
    {
      "action": "send",
      "count": 1,
      "datetime": "2017-04-05T07:48:41Z",
      "email": "john@example.com",
      "list_id": 1,
      "message_id": 1,
      "xxh": "0eb51aefd919f90a",
      "campaign_id": 1
    }
  ],
  "error": 0,
  "error_text": "Successful operation"
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
action	string	Действие подписчика (см. ниже)
count	int	Количество действий
datetime	string	Дата и время действия
email	string	Адрес подписки
db_id (list_id)	int	Идентификатор базы данных
message_id	int	Идентификатор шаблон сообщения
xxh	string	xxhash идентификатор профиля
campaign_id	int	Идентификатор кампании

События в истории профиля (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	Ошибка при заполнении формы (попытка повторного заполнения, технические проблемы и др.)