Перейти к содержанию

Построение гистограммы инцидентов или происшествий

Запрос

Тип Метод
POST /service_asset_findings/hist

Описание: при выполнении запроса будет построена гистограмма инцидентов или связанных с ними происшествий с учетом заданных параметров поиска.

При построении гистограммы по происшествиям поиск сначала выполняется по инцидентам, после чего учитываются связанные с найденными инцидентами происшествия.

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

POST

http://127.0.0.1/cruddy/v2/service_asset_findings/hist

Тело запроса:

Параметр Тип данных Обязательность Описание
period string Required Временной интервал, по которому группируются данные гистограммы. Значение указывается в формате PostgreSQL interval, например 10 minutes. Для месяца и года поддерживаются только значения 1 month и 1 year
entity string Optional Тип сущности, по которой строится гистограмма. Допустимые значения:
- service_asset_findings — инциденты;
- occurrences — происшествия, связанные с найденными инцидентами.
Значение по умолчанию: service_asset_findings
search object Optional Параметры поиска инцидентов в формате GenericSearchRequest. Независимо от значения entity поиск выполняется по инцидентам

Подробнее о параметрах объекта search см. в разделе Поиск инцидентов.

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

{
  "period": "10 minutes",
  "entity": "service_asset_findings"
}

Пример построения гистограммы по происшествиям:

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

{
  "period": "1 hour",
  "entity": "occurrences"
}

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Параметры ответа:

Параметр Тип данных Описание
hist Array<object> Данные гистограммы
hist[].ts string time Момент времени. Формат: date-time
hist[].cnt integer Количество происшествий в соответствующем временном интервале
Пример ответа

{
  "hist": [
    {
      "ts": "2026-09-04T12:00:00Z",
      "cnt": 15
    },
    {
      "ts": "2026-09-04T12:10:00Z",
      "cnt": 8
    }
  ]
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request Некорректные параметры поиска, период или тип сущности
401 can't get user info Невозможно аутентифицировать пользователя
500 Internal Server Error Другие ошибки сервера

Возможные ошибки:

  • 400 — "missing uid header" — отсутствует заголовок Pgr-User-ID;
  • 400 — "Pgr-User-Id should be uuid format" — неверный формат Pgr-User-ID;
  • 400 — "Bad Request" — неверный тип параметра запроса либо отсутствует обязательный параметр;
  • 400 — "filters: ..." — ошибка в параметрах фильтрации;
  • 400 — "empty period" — период не задан;
  • 400 — "not supported period" — передано неподдерживаемое значение периода, например 2 month;
  • 400 — "invalid period" — неверный формат поля period;
  • 400 — "invalid entity" — недопустимое значение поля entity;
  • 401 — "can't get user info:" — невозможно аутентифицировать пользователя;
  • 500 — "Internal Server Error" — другие ошибки сервера.

Примечание: Текст ошибки не фиксированный и может изменяться в зависимости от фактического ответа на запрос.

Пример ответа с кодом 400

{
  "error": "invalid period"
}

Пример ответа с кодом 401

{
  "error": "can't get user info:"
}

Пример ответа с кодом 500

{
  "error": "Internal Server Error"
}