Общие отчеты

id

number

да

да

Уникальный идентификатор обращения. Для получения детализированной информации по каждому типу обращения можно использовать следующие методы: "get.chats_report", "get.goals_report", "get.offline_messages_report", "get.calls_report"

communication_type

enum

chat, call, goal, offline_message

да

да

да

Тип обращения. Для получения детализированной информации по каждому типу обращения можно использовать следующие методы: "get.chats_report", "get.goals_report", "get.offline_messages_report", "get.calls_report"

communication_number

number

да

да

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

communication_page_url

string

нет

нет

нет

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

date_time

iso8601

YYYY-MM-DD hh:mm:ss

да

да

да

Дата и время обращения

ua_client_id

string

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

ym_client_id

string

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

sale_date

iso8601

YYYY-MM-DD hh:mm:ss

да

да

Дата сделки

sale_cost

number

да

да

Сумма сделки

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

да

Канал.

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

tags

array

да

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

tag_id

number

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

tag_name

string

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

tag_type

enum

auto, manual

Тип тега

tag_change_time

iso8601

YYYY-MM-DD hh:mm:ss

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

tag_user_id

number

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

tag_user_login

string

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

tag_employee_id

number

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

tag_employee_full_name

string

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

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

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

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

да

да

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

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

visitor_custom_properties

array

да

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

property_name

string

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

property_value

string

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

Сайт

site_id

number

да

да

да

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

site_domain_name

string

да

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

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

campaign_id

number

да

да

да

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

campaign_name

string

да

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

visit_other_campaign

boolean

true, false

да

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

Сегменты

segments

array

да

Сегменты

segment_name

string

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

segment_id

number

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

UTM-метки

utm_source

string

да

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

utm_medium

string

да

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

utm_term

string

да

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

utm_content

string

да

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

utm_campaign

string

да

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

utm_referrer

string

да

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

utm_expid

string

да

Идентификатор эксперимента в Google Analytics

OS-метки

openstat_ad

string

да

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

openstat_campaign

string

да

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

openstat_service

string

да

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

openstat_source

string

да

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

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

attributes

array

• first — Первый качественный
• through— Сквозной первый качественный
• primary— Первичное
• secondary— Вторичное
• lost — Потерянное
• 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

date

iso8601

YYYY-MM-DD

да

да

да

День за который приведена статистика, ISO

site_id

number

да

да

Идентификатор сайта в системе CoMagic

site_domain_name

string

да

да

Доменное имя сайта

campaign_id

number

да

да

да

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

campaign_name

string

да

да

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

campaign_ext_id

string

да

да

да

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

campaign_ext_name

string

да

да

да

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

engine

enum

yandex.direct,

google.adwords,

vk.ads,

mytarget.ads

да

Система рекламной кампании

banner_group_id

string

да

да

Идентификатор группы объявлений в рекламной системе

banner_group_name

string

да

Название группы объявлений в рекламной системе

keyword_id

string

да

да

Идентификатор ключевого слова в рекламной системе

keyword

string

да

Ключевое слово

cost_sum

string

да

Расходы на канал в данный день в валюте рекламной системы

shows_count

number

да

Показы для канала в данный день

clicks_count

number

да

Количество кликов по объявлению в данный день

chats_count

number

Количество чатов по рекламной кампании за день

calls_count

number

Количество звонков по рекламной кампании за день

goals_count

number

Количество целей по рекламной кампании за день

offline_messages_count

number

Количество заявок с сайта по рекламной кампании за день

current_banner_id

number

да

да

Текущий идентификатор объявления в рекламной системе

old_banner_ids

array

Предыдущие идентификаторы объявления в рекламной системе

visits_count

number

Количество посещений в данный день

current_banner_name

string

да

Название текущего банера в рекламной системе

daily_budget

number

да

Дневной бюджет

weekly_budget

number

да

Недельный бюджет

currency

enum

да

Валюта

session_ids

array

Список id сессий с этой РК за день

Список обращений

communications

array

Список обращений по этой РК за день

communication_type

string

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

communication_id

number

id обращения

attributes

array

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

Теги

tags

array

Теги на обращении

tag_id

number

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

tag_name

string

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

tag_type

enum

auto, manual

Тип тега

tag_change_time

iso8601

YYYY-MM-DD hh:mm:ss

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

tag_user_id

number

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

tag_user_login

string

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

tag_employee_id

number

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

tag_employee_full_name

string

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

id

number

да

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

first_name

string

да

да

Имя сотрудника

last_name

string

да

да

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

patronymic

string

да

Отчество сотрудника

full_name

string

да

да

Фамилия Имя Отчество

Информация по статусам сотрудников

status_stats

object

да

Статистика нахождения сотрудника в статусах. Для получения полного списка статусов необходимо использовать метод "get.statuses". Содержимое параметра зависит от параметра only_default_statuses_in_stats:

• при значении true ключ — мнемоника статуса, значение — время в секундах
• при значении false ключ — уникальный идентификатор статуса, значение — время в секундах, статистика по удаленным статусам также доступна, если есть данные за выбранный период

Группы сотрудника

groups

array

да

Группы в которых состоит сотрудник

group_id

number

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

group_name

string

Название группы