Skip to main content
POST
Список журналов статистики мониторинга

Авторизации

pubrio-api-key
string
header
обязательно

Уникальный токен API, представляющий действия, которые вы выполняете через API, и соответствующие права доступа и операции. Вы можете создать его в разделе Settings.

Тело

application/json
monitor_id
string<uuid>

Уникальный идентификатор монитора, для которого нужно получить журналы.

monitor_ids
string<uuid>[]

Фильтр по журналам этих мониторов.

monitor_log_ids
string<uuid>[]

Фильтр по этим конкретным записям журнала.

search_term
string

Поисковый термин, сопоставляемый с error_message, destination_type и detection_mode (подстрока без учёта регистра).

start_date
string<date>

Начало диапазона дат created_at (строка даты в формате ISO). Используется вместе с end_date.

end_date
string<date>

Конец диапазона дат created_at (строка даты в формате ISO). Используется вместе с start_date.

order_by
enum<string>
по умолчанию:created_at

Поле для сортировки. По умолчанию — created_at.

Доступные опции:
created_at,
total_credit,
processing_time_ms,
total_signals,
status,
retry_attempt
is_ascending_order
boolean
по умолчанию:false

Сортировка по возрастанию. По умолчанию — false (по убыванию).

statuses
string[]

Фильтр по статусу срабатывания (например, 'success', 'failure'). Также принимает виртуальное значение 'recovered' — неудачные срабатывания, повторная попытка которых впоследствии завершилась успехом.

signal_types
string[]

Фильтр по журналам, типы сигналов которых включают любое из этих значений.

destination_types
string[]

Фильтр по типам точек доставки (например, ['email', 'webhook']).

detection_modes
string[]

Фильтр по режимам обнаружения (например, ['company_first', 'signal_first']).

per_page
integer
по умолчанию:25

Количество записей на странице. По умолчанию — 25, что также является пределом на большинстве тарифов — лимит определяется параметром max_search_per_page вашей подписки, который возвращает Profile. Превышение возвращает HTTP 416 с кодом 41676 (или 41613 для поиска компаний и людей), а не усечённый набор результатов.

page
integer
по умолчанию:1

Номер страницы, начиная с 1. Предел определяется параметром max_search_page вашей подписки (max_company_search_page для поиска компаний), который возвращает Profile. Превышение возвращает HTTP 416.

Ответ

Успешный ответ. Оболочка ответа: { metadata: { filters }, data: { pagination, monitor_logs } }metadata.filters отражает фильтры, применённые к поиску.

metadata
object
data
object