This site is no longer updated.Go to new Conversational Cloud docs

Выгрузка логов диалогов


Платформа предоставляет доступ к ежедневным логам для анализа статистики диалогов. Пользователь самостоятельно может скачать логи со всего аккаунта за предыдущий день. Логи предоставляются в формате .csv.

Как скачать логи диалогов?

  1. Администратор аккаунта должен обратиться в техническую поддержку с запросом на активацию опции скачивания логов диалогов.

Если вы используете один из бизнес-тарифов (JAICP Business Standard, JAICP Business Pro, JAICP Business Pro+, JAICP Business Ultra, JAICP Business Enterprise), то опция была автоматически подключена при переходе на этот тариф.

  1. Затем администратор аккаунта добавляет роль RAWLOGS_ANALYTIC тем пользователям, которые должны иметь возможность скачивать файлы логов диалогов.

  2. Пользователь с ролью RAWLOGS_ANALYTIC авторизуется на платформе и скачивает логи диалогов по адресу:

http(s)://<hostname>/restapi/rawlogs/dd-mm-yyyy.csv

Здесь:

  • hostname — имя хоста, где размещена платформа, например app.jaicp.com.
  • dd, mm и yyyy — день, месяц и год соответственно.

Когда начнут формироваться логи?

Логи для выгрузки начинают формироваться с момента подключения опции. Логи диалогов, сформированные до подключения, недоступны для скачивания.

Ежедневные логи записываются в файл за предыдущий день от момента запуска задачи на генерацию. По умолчанию логи формируются в 00:01 по часовому поясу UTC−0. При формировании логов за один и тот же день предыдущий файл будет перезаписан.

Логи диалогов в разделе Диалоги отображаются согласно часовому поясу, установленному в профиле пользователя, но в выгружаемом файле — по UTC−0.

Как повторно сгенерировать отчет?

Администратор аккаунта может запустить повторную генерацию отчета, вызвав метод выше с параметром force=true:

http(s)://<hostname>/restapi/rawlogs/run/{accountId}/dd-MM-yyyy?force=true

Новый отчет будет доступен через 10 минут по прежнему адресу.

У меня включено удаление логов диалогов

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

Есть другой способ скачать логи?

Файл также можно скачать по GET-запросу. Скачивание доступно только для аутентифицированного пользователя с ролью RAWLOGS_ANALYTIC. В запросах используйте basic-аутентификацию, а также указывайте в заголовках Product: botadmin.

Выгружаемые данные

В выгружаемом csv-файле представлены следующие колонки. Разделитель между колонками — ;.

Колонка Описание Пример
session_id Идентификатор сессии 20a8444a-e1dd-5865-5ee7-b03fcb65e19b.732196de-2de6-455f-b751-e2c9a4700c62
session_start_time Время начала сессии 28.01.2019 17:18:45
session_end_time Время окончания сессии 28.01.2019 21:18:45
session_questions_count Количество всех фраз в данной сессии 14
session_tag Метка сессии Запрос удовлетворен
channel_type Тип канала Telegram
channel_name Название канала demo_bot
client_id Идентификатор пользователя telegram-118460129-demobot-118460129-XLA-160021967-294227430
client_name Имя клиента John
project_name Название проекта Demobot
msg_rt Время записи фразы сервером 13.02.2019 13:41:12
msg_question Запрос от пользователя Найди ближайший банкомат
msg_answer Ответ бота Ближайший банкомат на станции метро Чкаловская
state_before Стейт до обработки запроса /Menu
state_after Стейт после обработки запроса /CatchAll/Switch/NoOperatorsOnline
msg_switched true — после запроса был перевод на оператора

false — перевода на оператора не было
true
msg_operator true — отвечал оператор

false — отвечал бот
false
msg_comment Комментарий к фразе поиск банкомата
msg_tags Метки к фразе банкоматы