Управление отчётами

По умолчанию максимальный период выгрузки отчёта с даты получения запроса = 3 месяца

Получение списка всех обращений

Метод get.communications_report
Описание Получение списка всех обращений
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выбокри

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
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читывается в рамках персоны.
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
  • advert
  • organic
  • referral
  • direct
  • paid
  • display
  • affiliate
  • email
  • social
  • internal
да Канал.
Проставленные теги
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
  • desktop
  • mobile
  • tablet
  • other
да да Устройство посетителя
Свойства посетителя
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 да Название кампании
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).
да Атрибут обращения

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.communications_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields:[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "communication_type":"enum",
        "communication_number":"number",
        "date_time":"iso8601",
        "ua_client_id":"string",
        "ym_client_id": "string",
        "sale_date":"iso8601",
        "sale_cost":"number",
        "search_query":"string",
        "search_engine":"string",
        "referrer_domain":"string",
        "referrer":"string",
        "entrance_page":"string",
        "gclid":"string",
        "yclid":"string",
        "ymclid":"string",
        "ef_id":"string",
        "channel":"enum",
        "tags":[
          {
            "tag_id":"number",
            "tag_name":"string",
            "tag_type":"enum",
            "tag_change_time":"iso8601",
            "tag_user_id":"number",
            "tag_user_login":"string",
            "tag_employee_id":"number",
            "tag_employee_full":"string"
          }
        ],
        "site_id":"number",
        "site_domain_name":"string",
        "campaign_id":"number",
        "campaign_name":"string",
        "visit_other_campaign":"boolean",
        "visitor_id":"number",
        "person_id":"number",
        "visitor_type":"enum",
        "visitor_session_id":"number",
        "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",
        "visitor_custom_properties":[
          {
            "property_name":"string",
            "property_value":"string"
          }
        ],
        "segments":[
          {
            "segment_id":"number",
            "segment_name":"string"
          }
        ],
        "utm_source":"string",
        "utm_medium":"string",
        "utm_term":"string",
        "utm_content":"string",
        "utm_campaign":"string",
        "openstat_ad":"string",
        "openstat_campaign":"string",
        "openstat_service":"string",
        "openstat_source":"string",
        "attributes":[

        ]
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение отчёта по сессиям звонков

Метод get.calls_report
Описание Получение отчёта по сессиям звонков "Список обращений" -> "Звонки"
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выбокри

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да да Уникальный идентификатор сессии звонка
start_time iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время начал сессии звонка
finish_time iso8601 YYYY-MM-DD hh:mm:ss да Время окончания сессии звонка
finish_reason enum incorrect_input numb_not_exists numb_is_inactive sitephone_is_not_configured app_is_inactive numa_in_black_list no_active_scenario simple_forwarding_is_not_configured site_not_exists call_generator_is_not_configured add_cdr_timeout success_finish api_permission_denied api_ip_now_allowed component_is_inactive employee_not_exists not_enough_money platform_not_found internal_error incorrect_config communication_unavailable да да да Причина окончания сессии звонка numb_not_exists - Виртуальный номер не найден incorrect_input - Некорректный ввод numb_is_inactive - Виртуальный номер не активен sitephone_is_not_configured - Сайтфон не настроен app_is_inactive - Клиент деактивирован numa_in_black_list - Вызывающий абонент в чёрном списке no_active_scenario - Не найден активный сценарий simple_forwarding_is_not_configured;Аналитика: простая переадресация не настроена site_not_exists - Сайт не найден call_generator_is_not_configured - Лидогенератор не настроен add_cdr_timeout - Обратитесь в службу технической поддержки api_permission_denied - Доступ к Call API запрещён api_ip_now_allowed - IP-адрес не в списке разрешённых component_is_inactive - Компонент не активен employee_not_exists - Сотрудник не найден not_enough_money - Недостаточно средств на счету platform_not_found - Обратитесь в службу технической поддержки internal_error - Обратитесь в службу технической поддержки incorrect_config - Недопустимая конфигурация или комбинация вызова communication_unavailable - Недоступный тип связи success_finish - Успешное завершение звонка
direction enum
  • in - Входящая;
  • out - Исходящая
да да да Направление сессии звонка
source enum
  • callapi - Call API;
  • callapi_informer_call - Call API Информационный звонок
  • callapi_scenario_call - Call API вызов сценария
  • callback - Callback;
  • callout - Callout;
  • call_tracking- Аналитика;
  • dynamic_call_tracking - Динамический call tracking
  • va - Виртуальная АТС;
  • sip - Исходящий с SIP;
  • consultant - Звонок через Консультант;
  • lead - Звонок через Лидогенератор;
  • sitephone - Звонок через Сайтфон;
  • retailcrm - Звонок из retailCRM;
  • faxout - Исходящий факс
да да да Источник звонка
is_lost boolean да да да Признак, что звонок потерянный или успешный
communication_number number да да Для сесии ВАТС пустой всегда, такова сейчас идеология сервиса
contact_phone_number string да да Номер контакта от которого поступил звонок в случае входящего звонка или номер контакта на который совершили звонок в случае исходящего звонка.
communication_id number да да Уникальный идентификатор обращения
communication_type enum call да Тип обращения
wait_duration number да да Длительность ожидания до первого разговора в секундах
total_wait_duration number да да Полная длительность ожидания звонящего на линии, значение в секундах
talk_duration number да да Длительность разговора. Считается от момента первого разговора контакта с сотрудником до начала постобработки, значение в секундах
clean_talk_duration number да да Чистая длительность разговора. Это только разговоры. Значение в секундах
total_duration number да да Длительность разговора. Считается от момента первого разговора контакта с сотрудником до начала постобработки, значение в секундах
postprocess_duration number да Длительность постобработки, значение в секундах
call_records array да Уникальный идентификатор ссылки на записанный разговор, см. метод "get.call_records". Можно прослушать вызвав запрос в браузере: http://app.comagic.ru/system/media/talk/{call_session_id}/{record_call_file_link_hash}/
voice_mail_records array Уникальный идентификатор ссылки на оставленное голосовое сообщение, см. метод "get.voice_mail_records". Можно прослушать вызвав запрос в браузере: http://app.comagic.ru/system/media/talk/{call_session_id}/{voice_mail_file_link_hash}/
virtual_phone_number string да да да Виртуальный номер
ua_client_id string Уникальный идентификатор в Universal Analytics
ym_client_id string Уникальный идентификатор пользователя Яндекс.Метрики
sale_date iso8601 YYYY-MM-DD hh:mm:ss да да Дата сделки
sale_cost number да да Сумма сделки
is_transfer boolean true, false да да Был ли трансфер в сессии звонка
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
  • advert
  • organic
  • referral
  • direct
  • paid
  • display
  • affiliate
  • email
  • social
  • internal
да Канал.
Проставленные теги
tags array да Теги, см. метод "get.tags"
tag_name string Уникальный идентификатор тега
tag_id number Название тега
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 Ф.И.О сотрудника, который протсавил тег
Сотрудники участвовавшие в звонке
employees array да Сотрудники, которые участвовали в звонке
employee_id number Уникальный идентификатор сотрудника
employee_full_name string Ф.И.О. сотрудника
is_answered boolean Признак, поднял сотрудник трубку или нет
is_talked boolean Признак, участвовал ли сотрудник в разговоре или нет
Последний ответивший сотрудник
last_answered_employee_id number да Уникальный идентификатор последнего сотрудника, который поднял трубку
last_answered_employee_full_name string да Ф.И.О последнего сотрудника, который поднял трубку
Первый ответивший сотрудник
first_answered_employee_id number да Уникальный идентификатор первого сотрудника, который первый поднял трубку
first_answered_employee_full_name string да Ф.И.О. первого сотрудника, который первый поднял трубку Последний разговаривавший сотрудник
Последний разговаривавший сотрудник
last_talked_employee_id number да Уникальный идентификатор последнего разговаривавшего сотрудника
last_talked_employee_full_name string да Ф.И.О последнего разговаривавшего сотрудника
Первый разговаривавший сотрудник
first_talked_employee_id number да Уникальный идентификатор первого разговаривавшего сотрудника
first_talked_employee_full_name string да Ф.И.О первого разговаривавшего сотрудника
Сценарий
scenario_name string да Название сценария по которому обрабатывался звонок
scenario_id number да да Уникальный идентификатор сценария по которому обрабатывался звонок
Сайт
site_domain_name string да Адрес сайта в интернете. Без указания протокола - "http://" или "https://"
site_id number да да Уникальный идентификатор сайта
Рекламная кампания
campaign_name string да Название рекламной кампании
campaign_id number да да Уникальный идентификатор рекламной кампании
visit_other_campaign boolean true, false Флаг показывает заходил ли посетитель (в пределах персоны) по другим рекламным кампаниям
Информация о посетителе
visitor_id number да да Уникальный идентификатор посетителя
person_id number да Уникальный идентификатор персоны
visitor_type enum Новый, Вернувшийся, Не заполнен да да Тип посетителя
visitor_session_id number да Уникальный идентификатор сессии посетителя
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]
property_name string Имя свойства, которое должно быть присвоено
property_value string Значение свойства
Сегменты
segments array да Сегменты
segment_id number Уникальный идентификатор сегмента
segment_name string Название сегмента
Call API
call_api_request_id number да Уникальный идентификатор запроса к API, который запросе.
call_api_external_id string да Уникальный идентификатор, который может быть события звонка с внешней системой.
Контакт из адресной книги
contact_id number да Уникальный идентификатор контакта
contact_full_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).
да Атрибуты обращения

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.calls_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"string",
    "date_till":"string",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "start_time":"iso8601",
        "finish_time":"iso8601",
        "virtual_phone_number":"string",
        "is_transfer":"boolean",
        "finish_reason":"enum",
        "direction":"enum",
        "source":"enum",
        "communication_number":"number",
        "communication_id":"number",
        "communication_type":"enum",
        "is_lost":"boolean",
        "wait_duration":"number",
        "total_wait_duration":"number",
        "talk_duration":"number",
        "clean_talk_duration":"number",
        "total_duration":"number",
        "postprocess_duration":"number",
        "ua_client_id":"string",
        "ym_client_id": "string",
        "sale_date":"iso8601",
        "sale_cost":"number",
        "search_query":"string",
        "search_engine":"string",
        "referrer_domain":"string",
        "referrer":"string",
        "entrance_page":"string",
        "gclid":"string",
        "yclid":"string",
        "ymclid":"string",
        "ef_id":"string",
        "channel":"enum",
        "site_id":"number",
        "site_domain_name":"string",
        "campaign_id":"number",
        "campaign_name":"string",
        "visit_other_campaign":"boolean",
        "visitor_id":"number",
        "person_id":"number",
        "visitor_type":"enum",
        "visitor_session_id":"number",
        "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",
        "last_answered_employee_id":"number",
        "last_answered_employee_full_name":"string",
        "first_answered_employee_id":"number",
        "first_answered_employee_full_name":"string",
        "scenarion_id":"number",
        "scenarion_name":"string",
        "call_api_external_id":"string",
        "call_api_request_id":"number",
        "contact_phone_number":"string",
        "contact_full_name":"string",
        "contact_id":"number",
        "utm_source":"string",
        "utm_medium":"string",
        "utm_term":"string",
        "utm_content":"string",
        "utm_campaign":"string",
        "openstat_ad":"string",
        "openstat_campaign":"string",
        "openstat_service":"string",
        "openstat_source":"string",
        "attributes":[

        ],
        "call_records":[

        ],
        "voice_mail_records":[

        ],
        "tags":[
          {
            "tag_id":"number",
            "tag_name":"string",
            "tag_type":"enum",
            "tag_change_time":"iso8601",
            "tag_user_id":"number",
            "tag_user_login":"string",
            "tag_employee_id":"number",
            "tag_employee_full_name":"string"
          }
        ],
        "visitor_custom_properties":[
          {
            "property_name":"string",
            "property_value":"string"
          }
        ],
        "segments":[
          {
            "segment_id":"number",
            "segment_name":"string"
          }
        ],
        "employees":[
          {
            "employee_id":"number",
            "employee_full_name":"string",
            "is_answered":"boolean"
          }
        ]
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение CDR по сессии звонка

Метод get.call_legs_report
Описание Получение списка CDR по сессии звонка
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выбокри

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да да Уникальный идентификатор CDR
call_session_id number да да да Уникальный идентификатор сессии звонка (см. метод get.calls_report)
call_records array да Уникальный идентификатор ссылки на записанный разговор. Можно прослушать вызвав запрос в браузере:
http://app.comagic.ru/system/media/talk/{call_session_id}/{record_call_file_link}
Берем из call_session_log по событие record_started
start_time iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время начала плеча
connect_time iso8601 YYYY-MM-DD hh:mm:ss да Дата и время поднятия трубки
duration number да да да Продолжительность плеча с начала поднятия трубки. Значение в секундах
total_duration number да да да Общая продолжительность плеча. Значение в секундах
virtual_phone_number string да да да Виртуальный номер
calling_phone_number string да да да Номер звонящего
called_phone_number string да да да Номер кому звонили
direction enum in, out да да да Направление плеча
is_transfered boolean true, false да да да Трансферное ли это плечо
is_operator boolean true, false да да да Принадлежит ли это плечо оператору
employee_id number да да да Уникальный идентификатор сотрудника, кому звонили
employee_full_name string да да Ф.И.О. сотрудника, кому звонили
employee_phone_number string да да Номер телефона сотрудника
employee_rating number да да да Рейтинг проставленный сотруднику в постобработке
scenario_id number да да да Уникальный идентификатор сценария
scenario_name string да да Название сценария
is_coach boolean true, false да да да Тренерское ли плечо
release_cause_code number да да да Номер Cause Code (см. Q850)
release_cause_description string да да да Описание cause code
is_failed boolean true, false да да да Поднял ли оператор трубку
is_talked boolean true, false да да Состоялся ли разговор
contact_id id Уникальный идентификатор контакта
contact_full_name string Ф.И.О. контакта
contact_phone_number string Номер контакта от которого поступил звонок в случае входящего звонка или номер контакта на который совершили звонок в случае исходящего звонка

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.call_legs_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "call_session_id":"number",
        "call_records":[

        ],
        "start_time":"iso8601",
        "connect_time":"iso8601",
        "duration":"number",
        "total_duration":"number",
        "virtual_phone_number":"string",
        "calling_phone_number":"string",
        "called_phone_number":"string",
        "direction":"enum",
        "is_transfered":"boolean",
        "is_operator":"boolean",
        "employee_id":"number",
        "employee_full_name":"string",
        "employee_phone_number":"string",
        "employee_rating":"number",
        "scenario_id":"number",
        "scenario_name":"string",
        "is_coach":"boolean",
        "release_cause_code":"number",
        "release_cause_description":"string",
        "is_failed":"boolean",
        "is_talked":"boolean",
        "contact_id":"number",
        "contact_full_name":"string",
        "contact_phone_number":"string"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение списка достигнутых целей

Метод get.goals_report
Описание Получение списка достигнутых целей
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выбокри

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да Уникальный идентификатор цели
date_time iso8601 YYYY-MM-DD hh:mm:ss Дата и время достижения цели
name string да да Название цели
communication_number number да да Номер обращения. Расcчитывается в рамках персоны.
communication_id number да да Уникальный идентификатор обращения
communication_type enum goal да да Тип обращения
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
  • advert
  • organic
  • referral
  • direct
  • paid
  • display
  • affiliate
  • email
  • social
  • internal
да Канал.
Проставленные теги
tags array да Теги, см. метод "get.tags"
tag_id number Уникальный идентификатор тега
tag_name string Название тега
tag_type enum auto, manual Тип тега
tag_change_time iso8601 Время простановки тега
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
да Атрибуты обращения
  • primary - Первичное
  • secondary - Вторичное
  • lost - Потерянное
  • target - Целевое
  • off-target - Не целевое
  • quality - Качественное
  • rest - целевые повторные обращения (обращения, совершенные период повторного обращения, настроенного для сайта в ЛК CoMagic).

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.goals_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "date_time":"iso8601",
        "name":"string",
        "communication_number":"number",
        "communication_id":"number",
        "communication_type":"enum",
        "ua_client_id":"string",
        "ym_client_id": "string",
        "sale_date":"iso8601",
        "sale_cost":"number",
        "search_query":"string",
        "search_engine":"string",
        "referrer_domain":"string",
        "referrer":"string",
        "entrance_page":"string",
        "gclid":"string",
        "yclid":"string",
        "ymclid":"string",
        "ef_id":"string",
        "channel":"enum",
        "tags":[
          {
            "tag_id":"number",
            "tag_name":"string",
            "tag_type":"enum",
            "tag_change_time":"iso8601",
            "tag_user_id":"number",
            "tag_user_login":"string",
            "tag_employee_id":"number",
            "tag_employee_full_name":"string"
          }
        ],
        "site_id":"number",
        "site_domain_name":"string",
        "campaign_id":"number",
        "campaign_name":"string",
        "visit_other_campaign":"boolean",
        "visitor_id":"number",
        "person_id":"number",
        "visitor_type":"enum",
        "visitor_session_id":"number",
        "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",
        "visitor_custom_properties":[
          {
            "property_name":"string",
            "property_value":"string"
          }
        ],
        "segments":[
          {
            "segment_id":"number",
            "segment_name":"string"
          }
        ],
        "utm_source":"string",
        "utm_medium":"string",
        "utm_term":"string",
        "utm_content":"string",
        "utm_campaign":"string",
        "openstat_ad":"string",
        "openstat_campaign":"string",
        "openstat_service":"string",
        "openstat_source":"string",
        "attributes":[

        ]
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение информации о чатах

Метод get.chats_report
Описание Получение информации о чатах
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выбокри

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да да Уникальный идентификатор чата. Все сообщения чата можно получить используя метод "get.chat_messages"
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_id number да да Уникальный номер обращения
communication_type enum chat Тип обращения
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
  • advert
  • organic
  • referral
  • direct
  • paid
  • display
  • affiliate
  • email
  • social
  • internal
да Канал.
Сотрудник принявший чат
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
да Атрибуты обращения
  • primary - Первичное
  • secondary - Вторичное
  • lost - Потерянное
  • target - Целевое
  • off-target - Не целевое
  • quality - Качественное
  • rest - целевые повторные обращения (обращения, совершенные в период повторного обращения, настроенного для сайта в ЛК CoMagic).

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.chat_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "status":"enum",
        "initiator":"enum",
        "date_time":"iso8601",
        "duration":"string",
        "answer_time":"number",
        "communication_number":"number",
        "communication_id":"number",
        "communication_type":"enum",
        "messages_count":"number",
        "ua_client_id":"string",
        "ym_client_id": "string",
        "sale_date":"iso8601",
        "sale_cost":"number",
        "is_transfer":"boolean",
        "release_cause":"enum",
        "search_query":"string",
        "search_engine":"string",
        "referrer_domain":"string",
        "referrer":"string",
        "entrance_page":"string",
        "gclid":"string",
        "yclid":"string",
        "ymclid":"string",
        "ef_id":"string",
        "channel":"enum",
        "employee_id":"number",
        "employee_full_name":"string",
        "employee_messages_count":"number",
        "employee_raiting":"number",
        "site_id":"number",
        "site_domain_name":"string",
        "campaign_id":"number",
        "campaign_name":"string",
        "visit_other_campaign":"boolean",
        "visitor_id":"number",
        "person_id":"number",
        "visitor_type":"enum",
        "visitor_session_id":"number",
        "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",
        "utm_source":"string",
        "utm_medium":"string",
        "utm_term":"string",
        "utm_content":"string",
        "utm_campaign":"string",
        "openstat_ad":"string",
        "openstat_campaign":"string",
        "openstat_service":"string",
        "openstat_source":"string",
        "attributes":[

        ],
        "visitor_custom_properties":[
          {
            "property_name":"string",
            "property_value":"string"
          }
        ],
        "segments":[
          {
            "segment_id":"number",
            "segment_name":"string"
          }
        ],
        "tags":[
          {
            "tag_id":"number",
            "tag_name":"string",
            "tag_type":"enum",
            "tag_change_time":"iso8601",
            "tag_user_login":"string",
            "tag_user_id":"number",
            "tag_employee_id":"number",
            "tag_employee_full_name":"string"
          }
        ]
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение всех сообщений чата

Метод get.chat_messages_report
Описание Получение всех сообщений чата
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
chat_id number да Уникальный идентификатор чата

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
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 да Фамилия Имя Отчество сотрудника

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.chat_messages_report",
  "params":{
    "access_token":"string",
    "chat_id":"number",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "chat_id":"number",
        "date_time":"iso8601",
        "text":"string",
        "source":"enum",
        "employee_id":"number",
        "employee_full_name":"string"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение информации по оффлайн заявкам

Метод get.offline_messages_report
Описание Получение информации по оффлайн заявкам
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выборки

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да да Уникальный идентификатор оффлайн заявки
date_time iso8601 YYYY-MM-DD hh:mm:ss Дата и время получения заявки
text string да Текст заявки
communication_number number да да Номер обращения. Расcчитывается в рамках персоны.
communication_type enum offline_message Тип обращения
communication_id number да да Уникальный идентификатор обращения
ua_client_id string Уникальный идентификатор в Universal Analytics
ym_client_id string Уникальный идентификатор пользователя Яндекс.Метрики
sale_date iso8601 YYY-MM-DD hh:mm:ss да да Дата сделки
sale_cost number да да Сумма сделки
status enum
  • processing
  • processed
  • not_processed
да да да Статус заявки
process_time iso8601 YYYY-MM-DD hh:mm:ss Дата и время, когда заявка была переведена в статус "Обработано" (см. параметр "status")
form_type enum Пользовательская, Стандартная да да да Тип формы с которой была отправлена оффлайн заявка
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
  • advert
  • organic
  • referral
  • direct
  • paid
  • display
  • affiliate
  • email
  • social
  • internal
да Канал.
Группа, выбранная посетителем
group_id number да да Уникальный идентификатор группы, выбранной постетителем
group_name string да да Название группы, выбранной посетителем
Сотрудник
employee_id number да да да Уникальный идентификатор сотрудника, который обработал заявку
employee_full_name string да да Фамилия Имя Сотрудника, который обработал заявку
employee_answer_message string Ответ сотрудника, который был отправлен на адрес электронной почты посетителя
employee_comment string Комментарий сотрудника при переводе заявки в статус "Обработано" (см. поле "status")
Проставленные теги
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_phone_number number да да Номер телефона посетителя оставленный в заявке
visitor_email string да да Адрес электронной почты оставленный посетителем
visitor_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_country string да Страна посетителя
visitor_region 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
да Атрибуты обращения
  • primary - Первичное
  • secondary - Вторичное
  • lost - Потерянное
  • target - Целевое
  • off-target - Не целевое
  • quality - Качественное
  • rest - целевые повторные обращения (обращения, совершенные в период повторного обращения, настроенного для сайта в ЛК CoMagic).

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.offline_messages_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "date_time":"iso8601",
        "text":"string",
        "communication_number":"number",
        "communication_type":"enum",
        "communication_id":"number",
        "ua_client_id":"string",
        "ym_client_id": "string",
        "sale_date":"iso8601",
        "sale_cost":"number",
        "status":"enum",
        "process_time":"iso8601",
        "form_type":"enum",
        "search_query":"string",
        "search_engine":"string",
        "referrer_domain":"string",
        "referrer":"string",
        "entrance_page":"string",
        "gclid":"string",
        "yclid":"string",
        "ymclid":"string",
        "ef_id":"string",
        "channel":"enum",
        "employee_id":"number",
        "employee_full_name":"string",
        "employee_answer_message":"string",
        "employee_comment":"string",
        "tags":[
          {
            "tag_id":"number",
            "tag_name":"string",
            "tag_type":"enum",
            "tag_change_time":"iso8601",
            "tag_user_id":"number",
            "tag_user_login":"string",
            "tag_employee_id":"number",
            "tag_employee_full_name":"string"
          }
        ],
        "site_id":"number",
        "site_domain_name":"string",
        "group_id":"number",
        "group_name":"string",
        "campaign_id":"number",
        "campaign_name":"string",
        "visit_other_campaign":"boolean",
        "visitor_id":"number",
        "visitor_name":"string",
        "visitor_phone_number":"number",
        "visitor_email":"string",
        "person_id":"number",
        "visitor_type":"enum",
        "visitor_session_id":"number",
        "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",
        "visitor_custom_properties":[
          {
            "property_name":"string",
            "property_value":"string"
          }
        ],
        "segments":[
          {
            "segment_id":"number",
            "segment_name":"string"
          }
        ],
        "utm_source":"string",
        "utm_medium":"string",
        "utm_term":"string",
        "utm_content":"string",
        "utm_campaign":"string",
        "openstat_ad":"string",
        "openstat_campaign":"string",
        "openstat_service":"string",
        "openstat_source":"string",
        "attributes":[

        ]
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение информации о сессии посетителя

Метод get.visitor_sessions_report
Описание Получение информации о сессии посетителя
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выборки

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
date_time iso8601 YYYY-MM-DD hh:mm:ss Дата и время сессии
id number Уникальный идентификатор сессии
ua_client_id string Уникальный идентификатор в Universal Analytics
ym_client_id string Уникальный идентификатор пользователя Яндекс.Метрики
gclid string Значение метки gclid
yclid string Значение метки yclid
ef_id string Значение метки ef_id
ymclid string Значение метки ymclid
referrer_domain string Домен реферера
referrer string Источник перехода
search_engine string Поисковая система
search_query string Поисковый запрос
entrance_page string Страница входа
exit_page Страница выхода
duration number Продолжительность сессии. Значение в секундах
channel enum
  • advert
  • organic
  • referral
  • direct
  • paid
  • display
  • affiliate
  • email
  • social
  • internal
Канал.
engine enum
  • yandex.metrika
  • yandex.direct
  • google.analytics
  • google.adwords
Платформа для рекламной кампании pcc.engine_mnemonic
Рекламная кампания
campaign_id number да да да Уникальный идентификатор рекламной кампании
campaign_name string да да Название рекламной кампании
Сайт
site_id number да да да Уникальный идентификатор сайта
site_domain_name string да да Адрес сайта в интернете. Без указания протокола - "http://" или "https://"
Информация о посетителе
person_id number да да Уникальный идентификатор персоны
visitor_id number да да да Уникальный идентификатор посетителя
visitor_device enum
    desktop mobile tablet other
да да да Устройство посетителя
visitor_country string да да Страна посетителя
visitor_city string да да Город посетителя
visitor_region string да да Регион посетителя
visitor_ip_address string IP-адрес посетителя
visitor_type enum Новый, Вернувшийся да да Тип посетителя
visitor_browser_name string да да Браузер посетителя
visitor_browser_version string да да Версия браузера посетителя
visitor_os_name string да да Название операционной системы посетителя
visitor_os_version string Версия операционной системы посетителя
visitor_provider string Интернет провайдер посетителя
visitor_screen string да да Разрешение монитора посетителя
visitor_language string да да Локализация устройства посетителя
Свойства посетителя
visitor_custom_properties array да Свойства посетителя, которые могут быть заданы через личный кабинет или с помощью JavaScript API [мето д Comagic.setProperty(name, value);]
property_name string Имя свойства, которое должно быть присвоено посетителю
property_value string Значение свойства
UTM-метки
utm_source string да UTM-source
utm_medium string да UTM-medium
utm_term string да UTM-term
utm_content string да UTM-content
utm_campaign string да UTM-campaign
Openstat-метки
openstat_ad string да Идентификатор рекламного объявления
openstat_campaign string да Идентификатор рекламной кампании
openstat_service string да Идентификатор сервиса, предоставляющего услуги
openstat_source string да Идентификатор площадки, раздела, страницы, места на странице, на котором было показано соответствующее рекламное объявление
Список посещённых страниц
hits_count number Количество посещенных страниц
hits array Список посещённых страниц
hit_time string Время перехода на страниц
hit_duration string Длительность посещения страницы. Формат "HH:MM:SS"
hit_url string Адрес страницы
Список сегментов
segments array да Сегменты
segment_name string Название сегмента
segment_id number Уникальный идентификатор сегмента
Список обращений
communications array да Тип обращения, см. метод "get.communications_report"
communication_type enum chat, call, goal, offline_message Тип обращения. Для получения детализированной информации по каждому типу обращения можно использовать следующие методы: "get.communications_report", "get.chats_report", "get.goals_report", "get.offline_messages_report", "get.calls_report"
communication_id number Уникальный идентификатор обращения. По данному идентификатору можно получить детализированную информацию используя следующие методы: "get.communications_report", "get.chats_report ", "get.goals_report ", "get.offline_messages_report ", "get.calls_report"
communication_date_time iso8601 YYYY-MM-DD hh:mm:ss Дата и время обращения

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.visitor_sessions_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "date_time":"iso8601",
        "gclid":"string",
        "ua_client_id":"string",
        "ym_client_id": "string",
        "yclid":"string",
        "ef_id":"string",
        "ymclid":"string",
        "engine":"enum",
        "referrer_domain":"string",
        "referrer":"string",
        "search_engine":"string",
        "search_query":"string",
        "entrance_page":"string",
        "duration":"string",
        "site_id":"number",
        "site_domain_name":"string",
        "camapign_id":"number",
        "campaign_name":"string",
        "channel":"enum",
        "visitor_device":"enum",
        "visitor_id":"number",
        "visitor_country":"string",
        "visitor_city":"string",
        "visitor_region":"string",
        "visitor_ip_address":"string",
        "visitor_type":"enum",
        "visitor_browser_name":"string",
        "visitor_browser_version":"string",
        "visitor_os_name":"string",
        "visitor_os_version":"string",
        "visitor_provider":"string",
        "visitor_screen":"string",
        "visitor_language":"string",
        "visitor_custom_properties":[
          {
            "property_name":"string",
            "property_value":"string"
          }
        ],
        "utm_source":"string",
        "utm_medium":"string",
        "utm_term":"string",
        "utm_content":"string",
        "utm_campaign":"string",
        "openstat_ad":"string",
        "openstat_campaign":"string",
        "openstat_service":"string",
        "openstat_source":"string",
        "hits_count":"number",
        "hist":{
          "hit_time":"string",
          "hit_duration":"string",
          "hit_url":"string"
        },
        "segments":[
          {
            "segment_name":"string",
            "segment_id":"number"
          }
        ],
        "communications":[
          {
            "communication_type":"enum",
            "communication_id":"number",
            "communication_date_time":"iso8601"
          }
        ]
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Получение детализированного отчёта истории списаний по всем

плечам звонковых сессий

Метод get.financial_call_legs_report
Описание Получение детализированного отчёта истории списаний по всем плечам звонковых сессий
Кому доступен Партнёр, Клиент

Звонки с форм консультанта и сайтфона считаются исходящими звонками.

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала выборки
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания выборки

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
start_time iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время плеча
direction enum
  • in - Входящие;
  • out - Исходящие
да да да Направление плеча
source enum
  • callapi - Call API;
  • callapi_informer_call - Call API информационный звонок;
  • callapi_scenario_call - Call API вызов сценария
  • callback - Callback;
  • callout - Callout;
  • call_tracking- Аналитика;
  • dynamic_call_tracking - Динамический коллтрекинг;
  • va - Виртуальная АТС;
  • sip - Исходящий с SIP;
  • consultant - Звонок через Консультант;
  • lead - Звонок через Лидогенератор;
  • sitephone - Звонок через Сайтфон;
  • faxout - Исходящий факс;
  • retailcrm - retailCRM
да да да Источник плеча
call_session_id number да да да Уникальный идентификатор сессии звонка, см. метод "get.calls_report"
leg_id number да да да Уникальный идентификатор звонка, см. метод "get.call_legs_report"
В рамках одной сессии звонка возможно несколько вызовов
calling_phone_number string да да да Номер телефона звонящего
called_phone_number string да да да Номер телефона на который звонили
duration number да да да Продолжительность звонка, значение в секундах
chargeable_duration number да да да Тарифицированная длительность звонка, значение в секундах
direction_type enum
  • international - Международные;
  • national - Междугородние;
  • local - Местные (Москва и Московская область);
  • mobile - Мобильные
да да да Тип направления звонка
cost_per_minute number да да да Стоимость за минуту
total_charge number да да да Общая стоимость звонка
bonuses_charge number да да да Оплачено бонусами

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.financial_call_legs_report",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "start_time":"iso8601",
        "direction":"enum",
        "source":"enum",
        "call_session_id":"string",
        "leg_id":"number",
        "calling_phone_number":"string",
        "called_phone_number":"string",
        "duration":"number",
        "chargeable_duration":"number",
        "direction_type":"enum",
        "cost_per_minute":"number",
        "total_charge":"number",
        "bonuses_charge":"number"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Нам интересно ваше мнение о CoMagic.
Пожалуйста, оставьте контакты для связи с менеджером
ФИО*:
E-mail*:
Телефон*:
* - Обязательные для заполнения поля