Искать и просматривать журнал запросов

GET
/api/bot/journal

Одна строка на пару запрос/ответ — тот же журнал, что показывает страница Journal в дашборде, а не по одной строке на диалог. Используйте его, чтобы найти запросы по диапазону дат, результату или текстовому поиску; затем передайте chatId найденной строки в GET /api/bot/conversations/{chatId}/history, чтобы получить полный диалог.

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

Authorization

ApiKeyAuth
Authorization<token>

API-ключ интеграции со страницы бота Settings → API Keys, передаётся как есть, без префикса Bearer.

In: header

Query Parameters

page?integer

Номер страницы, начиная с 0. Размер страницы фиксирован — 20.

Range0 <= value
Default0
query?string

Ищет подстроку в тексте запроса (без учёта регистра) либо точное совпадение chatId/requestId/id строки. Id строки можно указать с префиксом A, как в дашборде, или без него (A1234 или 1234).

from?string

Нижняя граница в формате ISO 8601, включительно. Должна передаваться вместе с to (иначе 400). Расширение до границ суток не применяется — передавайте именно тот момент времени, который имеете в виду.

Formatdate-time
to?string

Верхняя граница в формате ISO 8601, включительно. Должна передаваться вместе с from.

Formatdate-time
type?array<>

Типы результата через запятую (либо параметр, повторённый несколько раз).

operatorReason?array<>

Причины передачи запроса оператору через запятую; имеет смысл, когда type включает OPERATOR.

sortField?string
Default"createdAt"

Value in

  • "id"
  • "chatId"
  • "type"
  • "createdAt"
sortDesc?boolean
Defaulttrue
includeAudit?boolean

Также вернуть для каждой строки разобранные steps журнала (какой шаблон/агент/скилл обработал запрос и почему).

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bot/journal"
{  "items": [    {      "id": 0,      "chatId": "string",      "type": "SUCCESS",      "createdAt": "2019-08-24T14:15:22Z",      "operatorReason": "REQUEST",      "request": "string",      "response": "string",      "explain": "string",      "agentConversationId": 0,      "mainConversationId": 0,      "steps": [        {}      ]    }  ],  "page": 0,  "pageSize": 20,  "total": 0,  "hasMore": true}