Skip to content

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

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

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

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
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
cm_id string да cm_id - это набор ValueTrack. ValueTrack - это параметры URL, которые можно добавлять к URL целевых страниц, чтобы собирать информацию об источнике кликов.
integrated_campaign_data object да Данные об интегрированной рекламной кампании
  • adv_system - Рекламная система
  • ext_campaign_id - ID РК в рекламной системе
  • ext_campaign_name - Название РК в рекламной системе
  • keyword_id - ID фразы в рекламной системе
  • keyword - Название фразы в рекламной системе
  • current_banner_id - Текущий идентификатор объявления в рекламной системе
  • old_banner_ids - Предыдущие идентификаторы объявления в рекламной системе
  • banner_name - Название банера в рекламной системе
  • group_id - ID группы в рекламной системе
  • group_name - Название группы в рекламной системе
  • auditory_id - ID аудитории в рекламной системе
  • auditory_name - Название аудитории в рекламной системе
  • placement_name - Название площадки в рекламной системе
  • yandex_placement_type - Тип площадки в рекламной системе
  • campaign_type - Тип РК в рекламной системе
  • device_type - Тип устройства в рекламной системе
  • position_type - Позиция клика в рекламной системе
  • yandex_region_id - ID регионав рекламной системе
  • yandex_region_name - Название региона
  • yandex_region_type - Тип региона
referrer_domain string Домен реферера
referrer string Источник перехода
search_engine string Поисковая система
search_query string Поисковый запрос
entrance_page string Страница входа
exit_page Страница выхода
duration number Продолжительность сессии. Значение в секундах
channel enum
  • display
  • paid
  • affiliate
  • messenger
  • social
  • email
  • organic
  • internal
  • recommendation
  • cashed
  • referral
  • direct
Канал.
engine enum
  • yandex.direct
  • google.adwords
  • vk.ads
  • mytarget.ads
Платформа для рекламной кампании 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",
        "integrated_campaign_data": {
          "adv_system": "enum",
          "ext_campaign_id": "string",
          "ext_campaign_name": "string",
          "keyword_id": "string",
          "keyword": "string",
          "banner_id": "number",
          "banner_name": "string",
          "group_id": "number",
          "group_name": "string",
          "auditory_id": "number",
          "auditory_name": "string",
          "placement_name": "string",
          "yandex_placement_type": "string",
          "campaign_type": "string",
          "device_type": "string",
          "position_type": "string",
          "yandex_region_id": "number",
          "yandex_region_name": "string",
          "yandex_region_type": "string"
        },
        "cm_id": "string",
        "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"