Получить журнал запросов

GET /api/v1/completion-log/journal

Возвращает историю запросов к боту.

URL

https://app.helpfy.ai/api/v1/completion-log/journal

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Подробнее — авторизация API.

Параметры запроса

Параметры строки запроса

Параметр	Тип	Обязательный	Описание
bot_unique_id	строка	Нет	Отбирать запросы по боту.
skip	число	Нет	Количество записей, которые нужно пропустить при просмотре списка.
take	число	Нет	Количество записей, возвращаемых за один запрос.
status	строка	Нет	Отбирать запросы по статусу обработки.
unique_id	строка	Нет	Отбирать записи по идентификатору запроса.
search	строка	Нет	Поиск по тексту запроса или ответа в журнале.
start_date	строка	Нет	Первый день периода журнала в формате ГГГГ-ММ-ДД.
end_date	строка	Нет	Последний день периода журнала в формате ГГГГ-ММ-ДД.

Пример запроса

curl --request GET 'https://app.helpfy.ai/api/v1/completion-log/journal' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'bot_unique_id=804be633-6f3b-4d38-abf3-8b2709e141fb' \
  --data-urlencode 'skip=0'

Ответы

HTTP	Описание
200	Успешный ответ

Пример ответа — HTTP 200

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "data": [
    {
      "unique_id": "11111111-1111-4111-8111-111111111111",
      "prompt": "Как изменить адрес доставки?",
      "status": "PENDING",
      "tool_calls_count": 1,
      "created_at": "2026-10-16T09:00:00.000Z",
      "updated_at": "2026-10-16T09:00:00.000Z",
      "bot": {
        "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
        "name": "Main knowledge bot",
        "primary_language": "ru",
        "first_line_greeting_enabled": true,
        "first_line_greeting_text": "Hello! How can I assist you today?",
        "rag_clarify_enabled": true,
        "scenario_clarify_enabled": false,
        "scenario_clarify_min_confidence": 55,
        "scenario_clarify_margin": 12,
        "allow_public_sources_in_support": true,
        "tools_enabled": false,
        "anonymize_pii": false,
        "max_output_tokens": 1000,
        "created_at": "2024-10-18T14:13:46.180Z",
        "updated_at": "2024-10-18T14:13:46.180Z"
      },
      "completion_token_usages": [
        {
          "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
          "completion_unique_id": "61296bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
          "type": "REGULAR",
          "mode": "PROMPTER",
          "created_at": "2024-01-01T12:00:00Z",
          "gpt_model": "yandexgpt",
          "gpt_version": "yandexgpt-lite",
          "gpt_version_label": "YandexGPT Lite",
          "tokens_used": 512,
          "source": "STANDARD",
          "historical_analysis_job_id": 1
        }
      ]
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}