KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
Хранилище
Тарификация
Участники
Логи
GET Список
GET Запись
POST Очистить
POST Оптимизировать
GET Активность
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
Склад (WM)
Сделки (DM)
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

# Получение логов

GET
/companies/{id}/modules/logs

Возвращает список записей логов с пагинацией и фильтрацией.

Query-параметры

QUERY_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20, максимум 100)
account_idoptional
string
ID аккаунта
Фильтр по инициатору действия
keyoptional
string
Ключ
Фильтр по коду разрешения (например: fm.transactions.create)
statusoptional
enum
successerrorpending
Статус
Фильтр по статусу
min_criticalityoptional
int
Мин. критичность
Нижняя граница критичности (1-10)
max_criticalityoptional
int
Макс. критичность
Верхняя граница критичности (1-10)
start_dateoptional
string
Начало
Начальная дата фильтрации (RFC 3339)
end_dateoptional
string
Конец
Конечная дата фильтрации (RFC 3339)
searchoptional
string
Поиск
Поиск по метаданным

Структура ответа

RESPONSE_DATA:
application/json
logsrequired
array
Логи
Список записей логов (Log[])
paginationrequired
array
pagination

Запись лога

LOG:
application/json
idrequired
string
ID
Уникальный идентификатор записи лога
keyrequired
string
Ключ
Код разрешения (например: fm.transactions.create)
statusrequired
enum
successerrorpending
Статус
Статус выполнения операции
criticalityrequired
int
Критичность
Степень важности (1-10)
account_idrequired
string
ID аккаунта
Идентификатор инициатора
request_idoptional
string
ID запроса
Идентификатор запроса для группировки
user_agentoptional
string
User-Agent
Клиентское приложение
ipoptional
string
IP
IP-адрес инициатора
created_atrequired
string
Создана
Дата создания записи (RFC 3339)

Примеры ответов

200
{
    "status": true,
    "message": "Logs retrieved successfully",
    "data": {
        "logs": [
            {
                "id": "aa0e8400-e29b-41d4-a716-446655440090",
                "key": "fm.transactions.create",
                "status": "success",
                "criticality": 8,
                "account_id": "550e8400-e29b-41d4-a716-446655440001",
                "request_id": "e08cf60221af/7tXcx4SYpF-007394",
                "user_agent": "Mozilla/5.0 ...",
                "ip": "1.1.1.1",
                "created_at": "2026-06-14T12:00:00Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/logs",
        "method": "GET"
    }
}

# Получение записи

GET
/companies/{id}/modules/logs/{logId}

Возвращает одну запись лога с полными метаданными.

Структура ответа

LOG_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор записи лога
keyrequired
string
Ключ
Код разрешения (например: fm.transactions.create)
statusrequired
enum
successerrorpending
Статус
Статус выполнения операции
criticalityrequired
int
Критичность
Степень важности (1-10)
account_idrequired
string
ID аккаунта
Идентификатор инициатора
request_idoptional
string
ID запроса
Идентификатор запроса для группировки
user_agentoptional
string
User-Agent
Клиентское приложение
ipoptional
string
IP
IP-адрес инициатора
created_atrequired
string
Создана
Дата создания записи (RFC 3339)

Примеры ответов

200
{
    "status": true,
    "message": "Log retrieved successfully",
    "data": {
        "id": "aa0e8400-e29b-41d4-a716-446655440090",
        "key": "fm.transactions.create",
        "status": "success",
        "criticality": 8,
        "account_id": "550e8400-e29b-41d4-a716-446655440001",
        "request_id": "e08cf60221af/7tXcx4SYpF-007394",
        "user_agent": "Mozilla/5.0 ...",
        "ip": "1.1.1.1",
        "metadata": {
            "amount": 5000,
            "direction": "income"
        },
        "created_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/logs/...",
        "method": "GET"
    }
}

# Очистка логов

POST
/companies/{id}/modules/logs/clear

Безвозвратно удаляет все записи логов организации.

Примеры ответов

200
{
    "status": true,
    "message": "Logs cleared successfully",
    "data": {},
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/logs/clear",
        "method": "POST"
    }
}

# Оптимизация

POST
/companies/{id}/modules/logs/optimize

Частично удаляет записи логов старше 30 дней, сохраняя недавнюю историю.

Примеры ответов

200
{
    "status": true,
    "message": "Logs optimized successfully",
    "data": {},
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/logs/optimize",
        "method": "POST"
    }
}

# Граф активности

GET
/companies/{id}/modules/logs/activity

Возвращает данные для графа активности — количество действий по дням.

Query-параметры

QUERY_PARAMS:
application/json
start_dateoptional
string
Начало
Начальная дата (RFC 3339)
end_dateoptional
string
Конец
Конечная дата (RFC 3339)

Структура ответа

LOG_ACTIVITY:
application/json
daterequired
string
Дата
День в формате YYYY-MM-DD
countrequired
int
Действий
Количество действий за день

Примеры ответов

200
{
    "status": true,
    "message": "Activity retrieved successfully",
    "data": [
        {
            "date": "2026-06-14",
            "count": 42
        },
        {
            "date": "2026-06-13",
            "count": 58
        }
    ],
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/logs/activity",
        "method": "GET"
    }
}