Журнал запросов

GET /core/history

Описание

Этот эндпоинт возвращает журнал запросов к системе. Журнал включает информацию о методе запроса, URL, коде ответа, а также времени выполнения. Эндпоинт используется для анализа активности пользователей, мониторинга работы системы и отладки запросов.

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

Обязательные параметры:

Нет

Вспомогательные параметры:

  • sortBy — параметр для сортировки по указанному полю (например, createdAt).
  • sortOrder — порядок сортировки: ASC (по возрастанию) или DESC (по убыванию).
  • limit — количество записей, возвращаемых в одном запросе (по умолчанию: 20).
  • page — номер страницы для постраничного вывода данных.

Пример:
GET /core/history/?sortBy=createdAt&sortOrder=DESC&limit=10&page=1&userId=5&code=200

Ответ

Возвращается в формате JSON и содержит следующую структуру данных:

  • id — Уникальный идентификатор записи.
  • name — Метод запроса (например, GET, POST).
  • url — URL, по которому был выполнен запрос.
  • code — HTTP-код ответа.
  • userId — Идентификатор пользователя, выполнившего запрос (если доступен).
  • createdAt — Дата и время выполнения запроса.
  • updatedAt — Дата и время обновления записи.

  • pagination — Информация о пагинации данных:
    • limit — Лимит записей на странице.
    • offset — Смещение от начала списка.
    • currentTotal — Количество записей на текущей странице.
    • total — Общее количество записей.
    • page — Номер текущей страницы.
GET
/core/history

При успешном запросе, ответ будет выглядеть так:

1{
2  "status": "success",
3  "payload": [
4    {
5      "id": 1,
6      "name": "POST",
7      "url": "/pages/",
8      "code": 200,
9      "userId": null,
10      "createdAt": "2024-10-29T09:38:54.000Z",
11      "updatedAt": "2024-10-29T09:38:54.000Z"
12    }
13  ],
14  "pagination": {
15    "limit": 10,
16    "offset": 0,
17    "currentTotal": 100,
18    "total": 100,
19    "page": 1
20  }
21}