API Streamwood
Виджеты для повышения
конверсии сайтов

Работа с контактами

Метод: POST/GET

URL запроса: api.streamwood.ru/leads

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

Параметр Значение
email Обязательный. Адрес электронной почты, используемый для входа в личный кабинет Streamwood.
api_key Обязательный. Ключ доступа к API Streamwood.
host_id Integer. ID сайта в системе Streamwood.
limit Integer. Количество записей в ответе. Если не задано: 10. Максимум: 200.
offset Integer. Количество записей, которые нужно не включать в ответ для постраничного вывода. По-умолчанию: 0.
asc Integer. Направление сортировки. По-умолчанию: 0.
0 — свежие в начале;
1 — свежие в конце.

Формат ответа

Параметр Значение
Data.limit Integer. Наложенное ограничение на количество извлекаемых записей.
Data.offset Integer. Наложенное значение пропуска количества записей.
Data.total Integer. Сколько всего записей доступно для извлечения.
Data.items Array. Массив содержащий информация о контактах.
Data.items.*.id Integer. ID контакта в системе Streamwood. Уникален для каждого контакта.
Data.items.*.client_name String. Имя клиента, если он его оставил.
Data.items.*.phone String. Номер телефона клиента, если он его оставил.
Data.items.*.email String. Адрес электронной почты клиента, если он его оставил.
Data.items.*.message String. Первое сообщение в чат или указанные значения в регистраторе/генераторе в зависимости от того в какой виджет был оставлен контакт.
Data.items.*.form_type String. Тип формы, в которую был оставлен контакт:

chat — обращение в виджет Онлайн-консультанта;
feedback — обратная связь, клиент не дождался ответа менеджера в виджете Онлайн-консультант;
invitation — автоприглашение написать в виджет Онлайн-консультанта;
generator — заявка в виджет Генератор клиентов;
recall — заказ звонка в Callback-виджете;
registrator — заявка в виджет Регистратор.
Data.items.*.url String. Адрес страницы, с которой был оставлен контакт.
Data.items.*.completed Boolean. Контакт помечен обработанным.
Data.items.*.created_at String. Дата и время, когда клиент оставил контакт.
Data.items.*.host.id Integer. ID сайта в системе Streamwood, на котором был оставлен контакт.
Data.items.*.host.name String. Имя сайта в системе Streamwood, на котором был оставлен контакт.
Data.items.*.session.id Integer. ID клиента в системе Streamwood.
Data.items.*.session.expired True. Содержится в ответе ТОЛЬКО если время жизни сессии клиента в системе Streamwood истекло. Все остальные параметры сессии при этом значении отсутствуют.
Data.items.*.session.client_name String. Имя клиента.
Data.items.*.session.last_visit String. Дата и время последнего визита клиента на сайт.
Data.items.*.session.created_at String. Дата и время первого визита клиента на сайт.
Data.items.*.session.ip String. IP-адрес клиента.
Data.items.*.session.url String. Адрес последней посещенной страницы на сайта.
Data.items.*.session.utm_campaign
Data.items.*.session.utm_source
Data.items.*.session.utm_medium
Data.items.*.session.utm_term
Data.items.*.session.utm_content
String. UTM-метки, если они присутствовали при обращении клиента.
Data.items.*.manager.id Integer. ID менеджера в системе Streamwood, который связан с контактом.
Data.items.*.manager.name String. Имя менеджера в системе Streamwood.
Data.items.*.department.id Integer. ID отдела обращения в системе Streamwood, который связан с контактом.
Data.items.*.department.name String. Название отдела обращения в системе Streamwood.