Получение логов диалога

Последние изменения: 07.07.2023

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

Для получения логов диалога в Sherlock Platform сначала надо авторизоваться.

Далее необходимо вызвать метод GET контроллера Request https://<sherlock_url>/API/V2/Request/Logs?<Параметры>. Полученный ранее токен надо передать в заголовке как Bearer Token.

В качестве параметров в метод передаются различные условия фильтрации (все параметры являются опциональными):

  • pageSize - количество возвращаемых записей

  • pageNumber - номер страницы с которой надо загружать логи. 0 - для загрузки с первой страницы

  • requestId - ID диалога для загрузки данных конкретного диалога.

  • logCategoryId - категории логов

    • 1 - Запуск сценариев

    • 2 - Логи ботов

    • 3 - Логи событий диалога

  • logTypeId - детализация типов логов, зависят от категории

    • Запуск сценариев (1) - не используется

    • Логи ботов (2):

      • 1 - Общие логи

      • 2 - Запуск таймера

      • 3 - Перезапуск таймера

      • 4 - Остановка таймера

      • 5 - Таймер выполнен

      • 6 - Внешний запрос

      • 7 - Отправка уведомления ботом

    • Логи событий диалога (3):

      • 1 - Назначен ответственный в диалоге

      • 2 - Снят ответственный в диалоге

      • 3 - Смена статуса диалога

      • 4 - Диалог поставлен в очередь

      • 5 - Диалог распределён очередью

      • 6 - Пользователь вступил в диалог

      • 7 - Пользователь вышел из диалога

      • 8 - Бот подключен к диалогу

      • 9 - Бот исключён из диалога

  • startDate, endDate - задают период логов по дате регистрации для фильтрации

  • timeZone - временная зона в которой указаны даты начала и окончания

  • searchTerm - ключевые слова для поиска

Детальное описание параметров постраничного разбиения описаны в статье.

Метод возвращает json с массивом логов. По каждой записи возвращается следующая информация:

[
    {
        "recordId": "<Guid>",
        "operationDate": "2023-07-05T19:15:21.193",
        "title": "4. Обращение закрыто",
        "logCategoryId": 1,
        "logTypeId": 0,
        "userId": "<Guid>",
        "userName": "6. Провожающий бот",
        "isBot": true,
        "isError": false,
        "result": ""
    }
]

Описание данных полей приведено ниже:

  1. recordId - уникальный идентификатор записи

  2. operationDate - дата записи

  3. title - Краткое описание - заголовок сценария, название установленного статуса, т.д.

  4. logCategoryId - категория лога. Смотри возможные значения выше

  5. logTypeId - тип лога. Смотри возможные значения выше

  6. userId - id бота или пользователя, выполнившего действие

  7. userName - Имя бота или пользователя, выполнившего действие

  8. isBot - true, если лог создан по действиям бота, false - по действию оператора

  9. isError - была или нет ошибка в ходе операции

  10. result - детальные результаты - логи ошибки, данные от внешнего сервиса, т.д.

Помогла ли вам статья?