OneTrace.pro Справка

Схема событий

Схема событий описывает, какие события должны приходить в проект и с какими свойствами: order_completed — с обязательной суммой-числом, currency — только EUR или USD. OneTrace.pro сверяет со схемой каждое событие и показывает нарушения: опечатку в имени события, сумму строкой, пропущенное свойство. Ошибки разметки сайта или интеграции находятся сразу, а не тогда, когда сегмент или отчёт уже посчитаны неверно.

Событие, которое нарушает схему, всё равно принимается и попадает в профиль: данные не теряются, даже если ошиблась сама схема. Схема событий доступна с тарифа «Рост».

Как описать события

Откройте Каталог данных и вкладку Схема событий. Менять схему могут роли с правом «Управление каталогом событий» — «Менеджер» и выше; остальные видят схему и нарушения.

  1. Нажмите Добавить текущие события — в схему попадут все события из каталога с их свойствами и увиденными типами. Или добавьте события по одному кнопкой Добавить событие.
  2. Проверьте свойства каждого события:
Колонка Что задаёт
Свойство Ключ свойства, как его отправляет сайт или сервер, например amount
Тип Текст, число, да/нет, дата и время, список или объект. Дата и время подходят и текстовому свойству
Обязательное Событие без этого свойства или с пустым значением — нарушение
Допустимые значения Через запятую, только у текста и чисел. Значение не из списка — нарушение; регистр учитывается: eur и EUR — разные значения
Описание Для разработчиков: что означает свойство
  1. Уберите события и свойства, которые больше не должны приходить: если они придут, это будет нарушение «Событие не описано» или «Свойство не описано».
  2. Нажмите Сохранить схему и включите Проверять события по схеме.

Изменения копятся на экране и сохраняются вместе. После сохранения счётчики нарушений начинаются заново: прежние относятся к старой схеме. Событие схемы, которое ещё ни разу не приходило, отмечено во вкладке События как «Ещё не приходило», а события схемы — пометкой «В схеме».

Схема событий в каталоге данных

Системные события платформы ($identify, $page, $message_sent и другие), а также identify, просмотры страниц и экранов приложения не проверяются — их схема задана платформой.

Нарушения

Нарушение Пример
Событие не описано Пришло product_viewd вместо product_viewed
Свойство не описано У order_completed пришло свойство coupon, которого нет в схеме
Нет обязательного свойства add_to_cart без quantity
Неверный тип Сумма пришла строкой "1250" вместо числа 1250
Недопустимое значение currency = eur, а в схеме — EUR и USD

Нарушения за 7 дней видны над списком событий схемы: сколько раз и когда было последнее, пример — тип значения или само недопустимое значение. Без права видеть персональные данные пример маскируется. Если событие не описано по ошибке схемы, а не разметки, нажмите В схему — оно добавится в черновик со свойствами из каталога.

Те же нарушения и график событий с нарушениями за сутки — в разделе Диагностика.

Схема событий в диагностике

Импорт, экспорт и API

Экспорт JSON скачивает сохранённую схему, Импорт JSON загружает файл в черновик — проверьте его и сохраните. Так одну схему переносят между проектами: например, на все магазины сети или с тестового проекта на рабочий.

Через публичный API схему читают (GET /api/v1/event-schema) и заменяют целиком (PUT /api/v1/event-schema, право ключа «Изменение схемы событий»), а нарушения за неделю получают запросом GET /api/v1/event-schema/violations. Формат файла и API один и тот же:

{
  "enabled": true,
  "events": [
    {
      "name": "order_completed",
      "label": "Оформил заказ",
      "properties": [
        { "key": "amount", "type": "number", "required": true },
        { "key": "currency", "type": "string", "required": true, "values": ["EUR", "USD"] }
      ]
    }
  ]
}

События, которых нет в документе, выходят из схемы, но остаются в каталоге данных со своими подписями и статистикой. Документ без events только включает или выключает проверку.