Получить расход проверок за период
Обновлено 8 октября 2026
GET
/usageПоказывает расход проверок. Не содержит банковских платежей. Значение days за пределами 1–365 заменяется ближайшей границей диапазона.
Передайте ключ организации в заголовке Authorization: Bearer <ключ>.
Пример запроса
Используйте NK_BASE и NK_KEY из быстрого старта. Переменные в пути, например RUN_ID, замените значениями из ваших ответов API.
curl --fail-with-body "$NK_BASE/usage" \
-H "Authorization: Bearer $NK_KEY"Параметры
| Параметр | Где / тип | Обязательный | Описание |
|---|---|---|---|
days | Запрос целое число | Нет | Глубина периода в днях, 1–365. По умолчанию: 30. |
Ответы и ошибки
200
Успешный ответ.
application/json
Поля ответа
tenant_idстрока · необязательное- Организация.
period_daysцелое число · необязательное- Дней в выбранном периоде.
sinceстрока · необязательное- Начало периода.
checks_leftцелое число · необязательное- Текущий остаток.
checks_includedцелое число · необязательное- Включено по тарифу.
checks_spentцелое число · необязательное- Израсходовано проверок за период.
runsобъект · необязательноеВложенные поля
totalцелое число · необязательное- Всего запусков.
doneцелое число · необязательное- Успешных.
failedцелое число · необязательное- Неуспешных.
401
Ключ не передан, неверен или отозван.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
403
Доступ закрыт или действие не разрешено.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
Другой ответ
Ошибка входного сервера или сети может иметь текстовое/HTML-тело. Проверяйте HTTP-статус и Content-Type.