Структура сеанса пользователя

Материал из Документация Ключ-АСТРОМ

На этой странице представлены описания всех возможных полей, которые может включать пользовательский сеанс.

Имейте в виду, что в Ключ-АСТРОМ версии 1.204 мы представили новые счетчики ошибок в USQL и экспорте сеансов для каждого действия пользователя, которые полностью согласуются с Ключ-АСТРОМ. В свою очередь, в Ключ-АСТРОМ версии 1.217 мы перестанем поддерживать следующие счетчики ошибок:

  • useraction.errorCount— Включает только ошибки JavaScript.
  • useraction.httpRequestsWithErrors— Учитывает только ошибки на стороне сервера.
  • useraction.failedXHRRequests— Учитываются только неудачные вызовы XHR, сделанные в браузере вашего конечного пользователя.
  • useraction.failedImages— Будет включено в новый requestErrorCount. Узнайте больше о том, как лучше всего заменить существующие счетчики ошибок новыми.

Объект UserSession

Сеанс пользователя , охватывающий несколько действий пользователя и дополнительную информацию о посещении пользователя.

Элемент Тип Описание
tenantId string Идентификатор среды Ключ-АСТРОМ, которая зафиксировала сеанс пользователя.

Это поле не может быть запрошено с помощью языка запросов сеанса пользователя.

userSessionId string Уникальный идентификатор сеанса пользователя.
startTime integer Отметка времени первого действия пользователя в сеансе пользователя в миллисекундах UTC.
endTime integer Отметка времени последнего действия пользователя в сеансе пользователя в миллисекундах UTC.
duration integer Продолжительность сеанса пользователя в миллисекундах.

Это рассчитывается как количество времени между началом первого действия пользователя и окончанием последнего действия пользователя.

internalUserId string Уникальный идентификатор пользователя, запустившего пользовательский сеанс.
userType string Тип пользователя. Обозначает реального пользователя-человека ( REAL_USER) или робота ( ROBOTили SYNTHETIC).

Элемент может содержать эти значения

  • REAL_USER
  • ROBOT
  • SYNTHETIC
reasonForNoSessionReplay string Причина отсутствия повтора сеанса.

Элемент может содержать эти значения

  • KILLED_EMERGENCY
  • KILLED_ERROR
  • KILLED_MIN_JS_AGENT_VERSION
  • KILLED_NO_LICENSE
  • KILLED_WRONG_CONTENT_TYPE
  • MISCONFIGURED_CLUSTER
  • MODULE_DISABLED
  • NO_ACTIVITY
  • OPTED_OUT_SESSION
  • OPT_IN_MODE
  • ROBOT_DETECTED
  • SAMPLED_OUT
  • UNABLE_TO_LOAD_WORKER
  • UNHANDLED_EXCEPTION
  • UNKNOWN
  • UNSUPPORTED_BROWSER
  • VIEW_EXCLUDED
reasonForNoSessionReplayMobile string Причина отсутствия повтора сеанса на мобильном телефоне.

Элемент может содержать эти значения

  • DISABLED
  • NO_AGENT
  • OPTED_OUT
  • UNKNOWN
applicationType string Тип приложения, используемого в сеансе пользователя.

Элемент может содержать эти значения

  • AMP_APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE_APPLICATION
  • WEB_APPLICATION
bounce boolean Сеанс пользователя имеет ( true) или не имеет ( false) возврат.

Отказ означает, что в пользовательском сеансе есть только одно (или меньше) действие пользователя.

newUser boolean Пользователь является новым ( true) или постоянным пользователем ( false).
userActionCount integer Количество действий пользователя в сеансе пользователя.
totalErrorCount integer Количество ошибок, обнаруженных в сеансе пользователя.
totalLicenseCreditCount integer Количество единиц DEM, потребляемых сеансом.
matchingConversionGoalsCount integer Количество целей конверсии, достигнутых сеансом пользователя.
matchingConversionGoals string[] Список целей конверсии, достигнутых сеансом пользователя.

Кроме того, вы можете определить цели конверсии для одного действия пользователя.

ip string IP-адрес (IPv4 или IPv6), с которого начинается сеанс пользователя.
continent string Континент, с которого начинается пользовательский сеанс (на основе IP-адреса).
country string Страна, из которой происходит пользовательский сеанс (на основе IP-адреса).
region string Регион, из которого исходит пользовательский сеанс (на основе IP-адреса).
city string Город, из которого исходит пользовательский сеанс (на основе IP-адреса).
browserType string Тип браузера, используемого для сеанса пользователя.
browserFamily string Семейство браузера, используемого для сеанса пользователя.
browserMajorVersion string Версия браузера, используемая для сеанса пользователя.
osFamily string Тип операционной системы, используемой для пользовательского сеанса.
osVersion string Версия операционной системы, используемой для пользовательского сеанса.
manufacturer string Обнаруженный производитель устройства, используемого для сеанса пользователя.
device string Обнаруженное устройство, используемое для сеанса пользователя.
userId string Идентификатор пользователя, предоставленный для сеанса пользователя тегами сеанса.
screenHeight integer Обнаруженная высота экрана устройства, используемого для пользовательского сеанса.
screenWidth integer Обнаруженная ширина экрана устройства, используемого для пользовательского сеанса.
screenOrientation string Обнаруженная ориентация экрана устройства, используемого на устройстве для пользовательского сеанса.

Элемент может содержать эти значения

  • LANDSCAPE
  • PORTRAIT
  • UNDEFINED
displayResolution string Обнаруженное разрешение экрана устройства, используемого для пользовательского сеанса.

Элемент может содержать эти значения

  • CGA
  • DCI2K
  • DCI4K
  • DVGA
  • FHD
  • FWVGA
  • FWXGA
  • GHDPlus
  • HD
  • HQVGA
  • HQVGA2
  • HSXGA
  • HUXGA
  • HVGA
  • HXGA
  • NTSC
  • PAL
  • QHD
  • QQVGA
  • QSXGA
  • QUXGA
  • QVGA
  • QWXGA
  • QXGA
  • SVGA
  • SXGA
  • SXGAMinus
  • SXGAPlus
  • UGA
  • UHD16K
  • UHD4K
  • UHD8K
  • UHDPlus
  • UNKNOWN
  • UWQHD
  • UXGA
  • VGA
  • WHSXGA
  • WHUXGA
  • WHXGA
  • WQSXGA
  • WQUXGA
  • WQVGA
  • WQVGA2
  • WQVGA3
  • WQXGA
  • WQXGA2
  • WSVGA
  • WSVGA2
  • WSXGA
  • WSXGAPlus
  • WUXGA
  • WVGA
  • WVGA2
  • WXGA
  • WXGA2
  • WXGA3
  • WXGAPlus
  • XGA
  • XGAPLUS
  • _1280x854
  • nHD
  • qHD
hasCrash boolean Сеанс пользователя включает ( true) или не включает ( false) сбой.
crashGroupId string В случае сбоя мобильного сеанса это идентификатор группы, к которой принадлежит этот сеанс.

Если сеанс не завершился сбоем или сеанс не является мобильным сеансом, он имеет nullзначение.

hasSessionReplay boolean Воспроизведение сеанса доступно ( true) или недоступно ( false) для сеанса.
isp string Интернет-провайдер, от которого исходит пользовательский сеанс (на основе IP-адреса).
clientType string Дополнительная информация о клиенте.

Это поле не может быть запрошено с помощью языка запросов сеанса пользователя. Вместо этого используйте поле browserType .

browserMonitorId string Идентификатор монитора синтетического браузера, создавшего сеанс.
browserMonitorName string Имя монитора синтетического браузера, создавшего сеанс.
stringProperties StringProperty[] Список пользовательских свойств сеанса пользователя со строковыми значениями.
longProperties LongProperty[] Список пользовательских свойств сеанса пользователя с целочисленными (короткими или длинными) значениями.
doubleProperties DoubleProperty[] Список пользовательских свойств сеанса пользователя с числовыми значениями с плавающей запятой.
dateProperties DateProperty[] Список пользовательских свойств сеанса пользователя со значениями даты.
userActions UserSessionUserAction[] Список действий пользователя, записанных в сеансе пользователя.
events UserSessionEvents[] Список дополнительных событий, записанных в сеансе пользователя.
errors UserSessionErrors[] Список ошибок, зафиксированных в сеансе пользователя.
syntheticEvents UserSessionSyntheticEvent[] Список синтетических событий, записанных в сеансе пользователя.
appVersion string Версия приложения, в которой был записан сеанс пользователя.

Эта информация предоставляется другой интеграцией, такой как OpenKit.

endReason string Причина завершения сеанса пользователя.

Элемент может содержать эти значения

  • DURATION_LIMIT
  • END_EVENT
  • EXTENDED_TIMEOUT
  • TEST_FAILED
  • TIMEOUT
  • USER_ACTION_LIMIT
numberOfRageClicks integer Количество кликов "гнева", обнаруженных в сеансе пользователя.
numberOfRageTaps integer Количество кликов "гнева", обнаруженных в сеансе пользователя.
userExperienceScore string Оценка пользовательского опыта сеанса пользователя.

Элемент может содержать эти значения

  • FRUSTRATED
  • SATISFIED
  • TOLERATED
  • UNDEFINED
carrier string Информация о носителе сеанса мобильного пользователя.
networkTechnology string Информация о сетевых технологиях сеанса мобильного пользователя.
connectionType string Сериализованный тип соединения сеанса мобильного пользователя.

Элемент может содержать эти значения

  • LAN
  • MOBILE
  • OFFLINE
  • UNKNOWN
  • WIFI
replayStart integer Отметка времени начала повтора сеанса в миллисекундах UTC.
replayEnd integer Отметка времени окончания повтора сеанса в миллисекундах UTC.
clientTimeOffset integer Смещение времени клиента, в миллисекундах
rootedOrJailbroken boolean Мобильное устройство является рутированным/взломанным ( true) или подлинным ( false).

Имеет значение, nullесли статус неизвестен или не определен. Пользовательские приложения всегда сообщают о неизвестном/неопределенном.

hasError boolean Сеанс пользователя включает ( true) или не включает ( false) ошибку.
partNumber integer Сеансы пользователей могут быть разделены на несколько частей по различным техническим причинам (например, после 200 действий пользователя). Это partNumberпредставляет собой количество каждой части общего пользовательского сеанса.

Объект StringProperty

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

Элемент Тип Описание
key string Пользовательский ключ свойства.
value string Строковое значение свойства.

Объект _ LongProperty

Настраиваемое свойство действия пользователя со значением Long.

Элемент Тип Описание
key string Пользовательский ключ свойства.
value integer Длинное значение свойства.

Объект DoubleProperty

Настраиваемое свойство действия пользователя со значением Double.

Элемент Тип Описание
key string Пользовательский ключ свойства.
value number Числовое значение свойства с плавающей запятой.

Объект DateProperty

Пользовательское свойство действия пользователя со значением даты.

Элемент Тип Описание
key string Пользовательский ключ свойства.
value string Значение свойства на дату.

Объект UserSessionUserAction

Действие пользователя.

Действие пользователя — это отдельное действие, выполняемое пользователем в рамках пользовательского сеанса, например клик мышью.

Элемент Тип Описание
name string Имя действия пользователя.

Как правило, это имя страницы, которая загружается как часть действия пользователя, или текстовое описание действия, например клик мышью.

domain string Домен DNS, в котором было записано действие пользователя.
targetUrl string Целевой URL действия пользователя.
type string Тип действия пользователя.

Элемент может содержать эти значения

  • Custom
  • EndVisit
  • Error
  • Load
  • RageClick
  • SyntheticHiddenAction
  • UserSessionProperties
  • VisitTag
  • Xhr
startTime integer Отметка времени начала действия пользователя в миллисекундах UTC.
endTime integer Отметка времени окончания действия пользователя в миллисекундах UTC.
duration integer Продолжительность действия пользователя в миллисекундах.

Это рассчитывается как время между отметками времени начала и окончания действия пользователя.

application string Имя приложения, в котором было записано действие пользователя.
internalApplicationId string Идентификатор объекта Ключ-АСТРОМ для приложения, в котором было записано действие пользователя.

Эта информация полезна при вызове различных REST API, например, в качестве ключа для запросов временных рядов.

internalKeyUserActionId string Идентификатор объекта Ключ-АСТРОМ ключевого действия пользователя.
speedIndex integer Индекс скорости действия пользователя в миллисекундах.

Рассчитывается как среднее время, необходимое для отображения всех видимых частей страницы.

apdexCategory string Индекс пользовательского опыта действия пользователя.

Элемент может содержать эти значения

  • FRUSTRATED
  • SATISFIED
  • TOLERATING
  • UNKNOWN
matchingConversionGoals string[] Список целей конверсии, достигнутых действием пользователя.

Кроме того, вы можете определить цели конверсии для сеанса пользователя в целом.

networkTime integer Количество времени, потраченное на передачу данных для действия пользователя, в миллисекундах.
serverTime integer Количество времени, затраченное на серверную обработку действия пользователя, в миллисекундах.
frontendTime integer Количество времени, затрачиваемое на отрисовку внешнего интерфейса для действия пользователя, в миллисекундах.
documentInteractiveTime integer Количество времени, затраченное на то, чтобы документ для действия пользователя стал интерактивным, в миллисекундах.
thirdPartyResources integer Количество сторонних ресурсов, загруженных для действия пользователя.
thirdPartyBusyTime integer Время, затраченное на ожидание сторонних ресурсов для действия пользователя, в миллисекундах.
cdnResources integer Количество ресурсов, извлеченных из CDN для действия пользователя.
cdnBusyTime integer Время, затраченное на ожидание ресурсов CDN для действия пользователя, в миллисекундах.
firstPartyResources integer Количество ресурсов, полученных с исходного сервера для действия пользователя.
firstPartyBusyTime integer Время, затраченное на ожидание ресурсов исходного сервера для действия пользователя, в миллисекундах.
hasCrash boolean Действие пользователя имеет ( true) или не имеет ( false) сбой.
domCompleteTime integer Время до завершения дерева DOM в миллисекундах.
domContentLoadedTime integer Время до загрузки дерева DOM в миллисекундах.
loadEventStart integer Время до начала события загрузки в миллисекундах.
loadEventEnd integer Время до завершения события загрузки в миллисекундах.
navigationStart integer Отметка времени начала навигации в миллисекундах UTC.
requestStart integer Время до запуска запроса в миллисекундах.
responseStart integer Время до начала ответа в миллисекундах.
responseEnd integer Время до завершения ответа в миллисекундах.
visuallyCompleteTime integer Время до визуального завершения страницы в миллисекундах.
syntheticEvent string Имя искусственного события , вызвавшего действие пользователя.
syntheticEventId string Идентификатор синтетического события , вызвавшего действие пользователя.
keyUserAction boolean Действие является ( true) или не является ( false) ключевым действием.
stringProperties StringProperty[] Список пользовательских свойств сеанса пользователя со строковыми значениями.
longProperties LongProperty[] Список пользовательских свойств сеанса пользователя с целочисленными (короткими или длинными) значениями.
doubleProperties DoubleProperty[] Список пользовательских свойств сеанса пользователя с числовыми значениями с плавающей запятой.
dateProperties DateProperty[] Список пользовательских свойств сеанса пользователя со значениями даты.
userActionPropertyCount integer Общее количество свойств в действии пользователя.
customErrorCount integer Общее количество пользовательских ошибок во время действия пользователя.
javascriptErrorCount integer Общее количество ошибок Javascript во время действия пользователя.
requestErrorCount integer Общее количество ошибок запроса во время действия пользователя.
largestContentfulPaint integer Самая большая отрисовка содержимого (LCP) — это время (в миллисекундах), которое потребовалось для отображения самого большого элемента на странице.

LCP — важная ориентированная на пользователя метрика для измерения скорости загрузки. Он отмечает момент, когда основное содержимое страницы, вероятно, загружено. Низкий LCP указывает на то, что страница загружается быстро.

firstInputDelay integer Задержка первого ввода (FID) — это время (в миллисекундах), которое потребовалось браузеру для ответа на первый ввод пользователя.

FID является важной ориентированной на пользователя метрикой для измерения реакции на нагрузку. Он количественно оценивает взаимодействие с пользователем при попытке взаимодействия с неотвечающими страницами. Низкий FID указывает на то, что страницу можно использовать.

totalBlockingTime integer Общее время блокировки — это общее время (в миллисекундах) между первой отрисовкой содержимого и временем перехода в интерактивный режим, в течение которого браузер был заблокирован достаточно долго, чтобы предотвратить реакцию на ввод.
cumulativeLayoutShift number Кумулятивный сдвиг макета (CLS) — это общая сумма всех отдельных баллов для каждого неожиданного изменения макета, которое происходит в течение всего срока службы страницы.

CLS — важная ориентированная на пользователя метрика для измерения визуальной стабильности. Он определяет, как часто пользователи сталкиваются с неожиданными изменениями макета. Низкий CLS указывает на то, что страница восхитительна.

Объект UserSessionEvents

Внешнее событие сеанса пользователя.

Элемент Тип Описание
type string Тип события.

Элемент может содержать эти значения

  • Behavioral
  • Crash
  • Error
  • PageChange
  • RageClick
  • RageTap
  • UserTag
  • UserTagFromMetaData
  • VisitTag
name string Название события.
domain string Домен DNS, в котором было записано событие.
startTime integer Отметка времени события в миллисекундах UTC.
application string Имя приложения на основе настроенных правил обнаружения.
internalApplicationId string Идентификатор объекта Ключ-АСТРОМ для приложения.

Эта информация полезна при вызове различных REST API, например, в качестве ключа для запросов временных рядов.

metadata string Метаданные, прикрепленные к событию.
page string Имя страницы, на которую перешел пользователь во время события смены страницы.
pageGroup string Группа страниц автоматически создается из страницы.
pageReferrer string Имя предыдущей страницы, с которой пользователь перешел во время события смены страницы.
pageReferrerGroup string Группа реферера страницы автоматически получается из реферера страницы.

Объект UserSessionErrors

Ошибка сеанса пользователя.

Элемент Тип Описание
type string Тип ошибки.

Элемент может содержать эти значения

  • Behavioral
  • Crash
  • Error
  • PageChange
  • RageClick
  • RageTap
  • UserTag
  • UserTagFromMetaData
  • VisitTag
name string Название ошибки.
domain string Домен DNS, в котором была зарегистрирована ошибка.
startTime integer Отметка времени ошибки в миллисекундах UTC.
application string Имя приложения на основе настроенных правил обнаружения.
internalApplicationId string Идентификатор объекта Ключ-АСТРОМ для приложения.

Эта информация полезна при вызове различных REST API, например, в качестве ключа для запросов временных рядов.

Объект UserSessionSyntheticEvent

Синтетическое событие сеанса пользователя.

Элемент Тип Описание
name string Имя синтетического события.
syntheticEventId string Идентификатор объекта Ключ-АСТРОМ для синтетического события.
sequenceNumber integer Порядковый номер синтетического события в рамках всего монитора браузера.
timestamp integer Отметка времени моделирования искусственного события в миллисекундах UTC.
type string Тип синтетического события. Например, клик или нажатие клавиши.
errorCode integer Код ошибки, возникшей во время этого события.
errorName string Описание ошибки, возникшей во время этого события.