Документация1С-Битрикс: Модулиnative.apiНастройки модуля

Аналитика

Вкладка «Аналитика» находится в разделе «Сервисы → API-платформа → Настройки модуля». Здесь включается история входящих запросов, выбираются HTTP-методы для подсчёта и очищается накопленная статистика.

Сбор входящих запросов

Флажок «Собирать входящие запросы» включает историю обращений, в том числе отказы, OPTIONS и досрочные ответы событий. По умолчанию он выключен. Сбор не зависит от выбранных ниже HTTP-методов для статистики.

При действующем для клиента лимите основная запись запроса сохраняется и без этого флажка. При отключённых сборе и лимите история не пополняется.

Для сохранения параметров, заголовков и ответов дополнительно включите нужные направления на вкладке «Логирование». Без включённого сбора эти журналы не записываются ни в базу, ни в файлы, даже если действует лимит. Изменение флажка сбора не меняет флажки логирования и наоборот.

Сбор статистики

HTTP-методы

Отметьте флажки «Собирать статистику …-запросов» для нужных методов: GET, POST, PUT, PATCH, DELETE, OPTIONS и HEAD. Для каждого метода ведётся отдельный счётчик. Если ничего не выбрано, сбор отключён.

Учитываются обращения, дошедшие до обработчика API модуля, включая запросы с отказом в доступе, ошибкой или ответом из кеша. Поэтому счётчики показывают количество обращений, а не только успешных выполнений контроллера.

Накопленные данные

После включения учитываются новые обращения. Ранее выполненные запросы не добавляются задним числом. Отключение метода останавливает его подсчёт, но сохраняет накопленное значение.

Общее количество и распределение по HTTP-методам отображаются на дашборде.

Статистика хранится отдельно от входящих запросов, которые используются для лимитирования. Отключение сбора статистики не отключает ограничения по запросам.

Очистка статистики

Кнопка «Очистить статистику» в строке «Накопленная статистика» обнуляет счётчики всех HTTP-методов, включая отключённые. Перед удалением требуется подтверждение. Отменить очистку нельзя.

После очистки подсчёт продолжается для выбранных методов. История входящих запросов и журналы событий сохраняются.

Для очистки требуется право изменения настроек. Кнопка не сохраняет изменения флажков: новый набор методов нужно сохранить отдельно.