Первые шаги - Документация

Введение

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

Шаг 1: Создание проекта

1 Откройте форму создания проекта

В личном кабинете нажмите кнопку "Создать первый проект" или "Новый проект". Вы также можете перейти по адресу /projects/new

2 Заполните информацию о проекте

В форме создания проекта укажите:

Название проекта (обязательно) — это название будет отображаться в списке ваших проектов
Адрес сайта (обязательно) — URL сайта, на котором будет установлен скрипт отслеживания (например, https://example.com)
Аватар проекта (необязательно) — URL изображения для отображения в интерфейсе проекта

3 Дополнительные настройки

При необходимости вы можете включить опцию "Запись видео сессий". Это позволит записывать и воспроизводить действия пользователей с помощью технологии session replay.

4 Создайте проект

Нажмите кнопку "Создать проект". После успешного создания вы будете перенаправлены на страницу проекта.

⚠️ Важно: Убедитесь, что адрес сайта указан правильно. Он будет использоваться для генерации уникального скрипта отслеживания.

Шаг 2: Подключение скрипта на сайт

1 Откройте вкладку "Вставка на сайт"

На странице проекта перейдите на вкладку "Вставка на сайт" (или "Embed"). Здесь вы найдете уникальный скрипт для вашего проекта.

2 Скопируйте код скрипта

Вы увидите код, который выглядит примерно так:

<script src="https://ваш-домен.ru/s/ВАШ_ТОКЕН.js"></script>

Нажмите кнопку копирования или скопируйте код вручную.

3 Вставьте скрипт на ваш сайт

Откройте HTML-код вашего сайта и вставьте скопированный скрипт перед закрывающим тегом </body>:

            <!DOCTYPE html>
<html>
<head>
    <!-- мета-теги и другие элементы head -->
</head>
<body>
    <!-- содержимое вашего сайта -->
    
    <!-- Скрипт отслеживания -->
    <script src="https://ваш-домен.ru/s/ВАШ_ТОКЕН.js"></script>
</body>
</html>
        

4 Проверьте подключение

После добавления скрипта на ваш сайт:

Откройте ваш сайт в браузере
Выполните несколько действий (кликните по элементам на странице)
Вернитесь в личный кабинет и откройте страницу проекта
Проверьте вкладку "Сессии" — вы должны увидеть новые сессии

💡 Совет: Скрипт начинает работать сразу после подключения. Все клики пользователей будут автоматически отслеживаться и отправляться в систему.

⚠️ Важно: Убедитесь, что скрипт размещен на всех страницах вашего сайта, где вы хотите отслеживать действия пользователей. Обычно это делается через общий шаблон или файл футера.

Шаг 3: Идентификация пользователей (опционально)

Если вы хотите отслеживать действия конкретных пользователей, вы можете использовать функцию идентификации. Это позволит связывать сессии с конкретными пользователями вашего приложения.

1 Добавьте код идентификации

После подключения основного скрипта добавьте код идентификации пользователя. Это нужно делать после того, как пользователь авторизовался на вашем сайте:

            <script>
    // Идентификация пользователя
    window.ulogger.identify('USER_ID', 'USER_NAME');
</script>
        

Замените USER_ID и USER_NAME на реальные данные пользователя.

2 Пример использования

Пример кода для идентификации пользователя после авторизации:

            // После успешной авторизации пользователя
if (window.ulogger) {
    window.ulogger.identify(
        '12345',  // ID пользователя из вашей БД
        'Иван Иванов'  // Имя пользователя
    );
}
        

3 Альтернативный способ

Вы также можете использовать метод init с объектом:

            window.ulogger.init({
    id: '12345',
    name: 'Иван Иванов'
});
        

💡 Совет: Идентификация пользователей необязательна. Если вы не используете её, все сессии будут помечены как анонимные. Идентификация полезна для анализа поведения конкретных пользователей и отслеживания их действий в разных сессиях.

Что дальше?

После выполнения всех шагов вы сможете:

Просматривать сессии пользователей на странице проекта
Анализировать действия пользователей в реальном времени
Использовать фильтры для поиска конкретных сессий
Просматривать детальную информацию о каждой сессии
Если включена запись видео сессий — воспроизводить действия пользователей

📚 Дополнительная информация: Для более подробной информации о работе с фильтрами, аналитикой и другими функциями системы обратитесь к другим разделам документации.