Получить проверки целостности бота

GET /api/v1/knowledge-integrity/bots/{botUniqueId}/journal

URL

https://app.helpfy.ai/api/v1/knowledge-integrity/bots/{botUniqueId}/journal

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

Заголовки

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

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

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

Параметры пути

Параметр	Тип	Обязательный	Описание
botUniqueId	строка	Да	Идентификатор бота.

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

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

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

curl --request GET 'https://app.helpfy.ai/api/v1/knowledge-integrity/bots/11111111-1111-4111-8111-111111111111/journal' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'unique_id=7827d9b8-8bb8-428b-984a-7bfcf3221f1f' \
  --data-urlencode 'bot_unique_id=f27bd861-8ad5-432d-9945-4e22458d6049'

Ответы

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

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

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

{
  "data": [
    {
      "unique_id": "7827d9b8-8bb8-428b-984a-7bfcf3221f1f",
      "scope": "GLOBAL",
      "kind": "STRUCTURAL",
      "status": "RUNNING",
      "bot_count": 6,
      "total_knowledges_checked": 4123,
      "total_pairs_checked": 2400,
      "issues_found": 9,
      "started_at": "2026-10-16T09:00:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}