Чаты

id

number

да

да

Уникальный идентификатор чата. Все сообщения чата можно получить используя метод "get.chat_messages_report"

status

enum

lost — Потерянный; succeed — Состоявшийся;

refused — Отклоненный

да

да

да

Статус чата

initiator

enum

Посетитель, Оператор, Автоприглашение

да

да

да

Инициатор чата

date_time

iso8601

YYYY-MM-DD hh:mm:ss

да

да

Дата и время начала чата

duration

string

да

да

да

Продолжительность чата. Значение в секундах

answer_time

number

да

да

да

Время ответа оператора. Значение в секндах

communication_number

number

да

да

Номер обращения. Расcчитывается в рамках персоны.

communication_page_url

string

нет

нет

нет

URL страницы на которой находился посетитель в момент обращения или страница последнего взаимодействия посетителя перед обращением.

communication_id

number

да

да

Уникальный номер обращения

communication_type

enum

chat

Тип обращения

chat_channel_type

enum

comagic

yandex.dialogs

dataapi

да

да

Тип канала

chat_channel_name

string

Имя канала

messages_count

number

Количество сообщений в чате

ua_client_id

string

Уникальный идентификатор в Universal Analytics

ym_client_id

string

Уникальный идентификатор пользователя Яндекс.Метрики

sale_date

iso8601

YYYY-DD-MM hh:mm:ss

да

да

Дата сделки

sale_cost

number

да

да

Сумма сделки

is_transfer

boolean

да

Был ли чат передан другому сотруднику

release_cause

enum

closed_by_timeout invite_rejected closed_by_operator closed_by_visitor visitor_banned external_window_closed visitor_disconnected visitor_session_expired

да

да

Причина завершения чата

search_query

string

да

Поисковый запрос

search_engine

string

да

Название поисковой системы

referrer_domain

string

да

Домен реферера

referrer

string

да

Источник перехода

entrance_page

string

да

Страница входа

gclid

string

да

Google Click Identifier

yclid

string

да

Yandex Click Identifier

ymclid

string

Yandex Market Click Identifier

ef_id

string

да

Используется для разметки ссылок в системе управления контекстной рекламой AdLense

channel

enum

• display
• paid
• affiliate
• messenger
• social
• email
• organic
• internal
• recommendation
• cashed
• referral
• direct

да

Канал.

Сотрудник принявший чат

employee_id

number

да

да

да

Уникальный идентификатор сотрудника

employee_full_name

string

да

Фамилия Имя Сотрудника

employee_raiting

number

да

Рейтинг оператора выставленный посетителем

employee_messages_count

number

Количество сообщений оператора в чате

Проставленные теги

tags

array

да

Теги, см. метод «get.tags»

tag_id

number

Уникальный идентификатор тега

tag_name

string

Название тега

tag_change_time

iso8601

YYYY-MM-DD hh:mm:ss

Время простановки тега

tag_type

enum

auto, manual

Тип тега

tag_user_id

number

Уникальный идентификатор пользователя, который проставил тег

tag_user_login

string

Логин пользователя проставившего тег

tag_employee_id

number

Уникальный идентификатор сотрудника, который проставил тег

tag_employee_full_name

string

Ф.И.О сотрудника, который проставил тег

Сайт

site_id

number

да

да

да

Уникальный идентификатор сайта

site_domain_name

string

да

Адрес сайта в интернете. Без указания протокола — "http://" или "https://"

Рекламная кампания

campaign_id

number

да

да

да

Уникальный идентификатор рекламной кампании

campaign_name

string

да

Название рекламной кампании

visit_other_campaign

boolean

Флаг показывает заходил ли посетитель (в пределах персоны) по другим рекламным кампаниям

Информация о посетителе

visitor_id

number

да

да

да

Уникальный идентификатор посетителя

person_id

number

да

да

Уникальный идентификатор персоны

visitor_type

enum

Новый, Вернувшийся, Не заполнен

да

да

Тип посетителя

visitor_session_id

number

да

да

Уникальный идентификатор сессии посетителя, см. "get.visitor_sessions_report"

visits_count

number

да

Общее количество посещений посетителя

visitor_first_campaign_id

number

да

Уникальный идентификатор первой рекламной кампании.

visitor_first_campaign_name

string

да

Название первой рекламной кампании

visitor_city

string

да

Город посетителя

visitor_region

string

да

Регион посетителя

visitor_country

string

да

Страна посетителя

visitor_device

enum

• desktop
• mobile
• tablet
• other

да

да

Устройство посетителя

Свойства посетителя

visitor_custom_properties

array

да

Свойства посетителя, которые могут быть заданы через личный кабинет или с помощью JavaScript API [метод Comagic.setProperty(name, value);]

property_name

string

Имя свойства, которое должно быть присвоено посетителю

property_value

string

Значение свойства

Сегменты

segments

array

да

Сегменты

segment_id

number

Уникальный идентификатор сегмента

segment_name

string

Название сегмента

UTM-метки

utm_source

string

да

Источник кампании

utm_medium

string

да

Канал кампании

utm_term

string

да

Ключевое слово кампании

utm_content

string

да

Содержание кампании

utm_campaign

string

да

Название кампании

OS-метки

openstat_ad

string

да

Идентификатор рекламного объявления

openstat_campaign

string

да

Идентификатор рекламной кампании

openstat_service

string

да

Идентификатор сервиса, предоставляющего услуги

openstat_source

string

да

Идентификатор площадки, раздела, страницы, места на странице, на котором было показано соответствующее рекламное объявление

Атрибуты обращения

attributes

array

• first — Первый качественный
• through — Сквозной первый качественный
• primary — Первичное
• secondary — Вторичное
• lost — Потерянное
• target — Целевое
• off-target — Не целевое
• quality — Качественное
• rest — целевые повторные обращения (обращения, совершенные в период повторного обращения, настроенного для сайта в ЛК CoMagic).

да

Атрибуты обращения

Расширенные UTM-метки

eq_utm_source

string

да

Расширенная utm_source

eq_utm_medium

string

да

Расширенная utm_medium

eq_utm_term

string

да

Расширенная utm_term

eq_utm_content

string

да

Расширенная utm_content

eq_utm_campaign

string

да

Расширенная utm_campaign

eq_utm_referrer

string

да

Расширенная utm_referrer

eq_utm_expid

string

да

Расширенная utm_expid

chat_id

number

да

да

Уникальный идентификатор чата, см. метод "get.chats_report"

date_time

iso8601

YYYY-MM-DD hh:mm:ss

да

да

Дата и время когда было отправлено сообщение

Все сообщения должны быть в порядке их отправки, т.е отсортированы по полю «date_time«

text

string

да

Текст сообщения

source

enum

Оператор, Посетитель, Система

да

Источник сообщения

Сотрудник

employee_id

number

да

да

да

Уникальный идентификатор сотрудника

employee_full_name

string

да

Фамилия Имя Отчество сотрудника