Получить журнал вызовов функций

GET /api/v1/completion-tool-call-log/journal

Возвращает историю вызовов функций и внешних API.

URL

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

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

Заголовки

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

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

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

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

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

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

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

Ответы

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

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

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

{
  "data": [
    {
      "unique_id": "11111111-1111-4111-8111-111111111111",
      "completion_unique_id": "11111111-1111-4111-8111-111111111111",
      "tool_name": "example",
      "step_index": 1,
      "status": "example",
      "call_id": "11111111-1111-4111-8111-111111111111",
      "arguments_json": "example",
      "result_json": "example",
      "rendered_url": "https://example.com/endpoint",
      "request_method": "example",
      "response_excerpt": "example",
      "error_message": "example",
      "duration_ms": 1,
      "created_at": "2026-10-16T09:00:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}