POST /api/v1/monitors

Мониторинг проверки во времени

Мониторинг создаёт регулярную лёгкую перепроверку продавца, объекта или комплексной проверки. Каждый цикл сравнивается с предыдущим снимком и формирует событие, список изменений и лёгкий акт.

Открыть в Swagger API в базе знаний

Кратко для ИИ

Когда использовать

Должная осмотрительность во времени: перед авансом, перед подписанием, перед регистрацией или в период сопровождения сделки.

Карта методов

Связанные методы

Эта страница описывает группу связанных методов. Для точной схемы параметров используйте Swagger, для продуктовой логики — блоки ниже.

POST/api/v1/monitors

Создать подписку мониторинга.

GET/api/v1/monitors

Получить список подписок мониторинга.

GET/api/v1/monitors/{monitor_id}

Получить карточку подписки и последние циклы.

PATCH/api/v1/monitors/{monitor_id}

Поменять расписание, URL события интеграции или статус.

DELETE/api/v1/monitors/{monitor_id}

Остановить мониторинг.

Сценарий

Как проходит сценарий

Шаг 1

Расписание

Задайте dates или interval_days + cycles_left/until.

Шаг 2

Циклы

Каждый цикл создаёт проверку, сравнивает её с прошлым снимком и формирует список изменений.

Шаг 3

События

События интеграции сообщают monitor.cycle_completed, monitor.change_detected или monitor.paused.

Шаг 4

Архив доказательств

Для каждого цикла доступен act_pdf_url и корневой хеш доказательного блока.

Обязательные поля

Поле	Обяз.	Описание
type	Да	Тип проверки: продавец, объект или комплексная проверка.
subject	Да	Данные продавца/объекта, которые нужно повторно проверять.
schedule_mode	Да	dates или interval.
dates	Нет	Конкретные даты циклов для schedule_mode=dates.
interval_days + cycles_left/until	Нет	Интервальное расписание с ограничением по числу циклов или дате окончания.

Пример curl

curl -X POST https://api.realiq.ru/api/v1/monitors \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: riq_live_xxx" \
  -d '{"type":"full","subject":{"seller":{"last_name":"Иванов"},"object":{"cadastral_number":"78:40:0008480:3996"}},"schedule_mode":"interval","interval_days":7,"cycles_left":4}'

JSON-запрос

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

Для GET-методов показано JSON-представление URL, query-параметров и заголовков. Для загрузки файла показана структура form-data.

{
  "type": "full",
  "subject": {
    "seller": {
      "last_name": "Иванов",
      "first_name": "Иван",
      "birth_date": "1980-01-01",
      "region": "Москва"
    },
    "object": {
      "cadastral_number": "78:40:0008480:3996"
    }
  },
  "schedule_mode": "interval",
  "interval_days": 7,
  "cycles_left": 4,
  "webhook_url": "https://crm.example.ru/realiq/webhook"
}

JSON-ответ

Пример успешного JSON-ответа

Пример отражает структуру реального ответа API. Значения ID, SHA и ссылок сокращены или заменены демонстрационными.

{
  "id": 42,
  "status": "active",
  "type": "full",
  "subject": {
    "seller": { "last_name": "Иванов", "first_name": "Иван" },
    "object": { "cadastral_number": "78:40:0008480:3996" }
  },
  "schedule_mode": "interval",
  "dates": null,
  "interval_days": 7,
  "until": null,
  "cycles_left": 4,
  "next_run_at": "2026-07-05T09:00:00Z",
  "last_run_at": null,
  "last_check_id": null,
  "webhook_url": "https://crm.example.ru/realiq/webhook",
  "created_at": "2026-06-28T09:00:00Z",
  "updated_at": "2026-06-28T09:00:00Z",
  "runs": [],
  "request_id": "req_1780000000_abcd"
}

Полный JSON-ответ

Полный пример ответа

Развёрнутый пример показывает, какие блоки обычно получает интегратор. Значения ID, SHA, ссылок и персональных данных демонстрационные.

{
  "id": 42,
  "status": "active",
  "type": "full",
  "subject": {
    "seller": {
      "last_name": "Иванов",
      "first_name": "Иван"
    },
    "object": {
      "cadastral_number": "78:40:0008480:3996"
    }
  },
  "schedule_mode": "interval",
  "dates": null,
  "interval_days": 7,
  "until": null,
  "cycles_left": 4,
  "next_run_at": "2026-07-05T09:00:00Z",
  "last_run_at": null,
  "last_check_id": null,
  "webhook_url": "https://crm.example.ru/realiq/webhook",
  "created_at": "2026-06-28T09:00:00Z",
  "updated_at": "2026-06-28T09:00:00Z",
  "runs": [
    {
      "id": 7,
      "check_id": "b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a",
      "ran_at": "2026-07-05T09:00:00Z",
      "status": "completed",
      "changed": true,
      "changes": {
        "items": [
          {
            "text": "Риск-индекс изменился: 12 → 32."
          }
        ]
      },
      "risk_before": 12,
      "risk_after": 32,
      "act_pdf_url": "https://realiq.ru/reports/monitor-42-run-7.pdf",
      "evidence_root_hash": "aa12...ee89",
      "charged_amount": 390
    }
  ],
  "request_id": "req_1780000000_abcd"
}

Поля ответа

Как читать поля ответа

Поле	Что означает
status	active, paused, finished или insufficient_funds.
schedule_mode	dates — конкретные даты; interval — регулярный цикл.
next_run_at	Дата следующей перепроверки.
runs[]	История циклов мониторинга, изменения, акт и доказательный блок.
changed/changes	Флаг и описание изменений относительно прошлого снимка.

Ошибки

Типовые ошибки метода

HTTP 400invalid_monitor_schedule

Неправильное расписание.

Что делать: Для interval задайте interval_days и until или cycles_left.

{
  "error_code": "invalid_monitor_schedule",
  "message": "Неправильное расписание.",
  "request_id": "req_1780000000_abcd"
}

HTTP 402insufficient_funds

Недостаточно баланса для цикла.

Что делать: Мониторинг будет поставлен в insufficient_funds.

{
  "error_code": "insufficient_funds",
  "message": "Недостаточно баланса для цикла.",
  "request_id": "req_1780000000_abcd"
}

HTTP 404not_found

Мониторинг не найден.

Что делать: Проверьте monitor_id и API-ключ.

{
  "error_code": "not_found",
  "message": "Мониторинг не найден.",
  "request_id": "req_1780000000_abcd"
}

Ответ processing

{
  "id": 42,
  "status": "active",
  "next_run_at": "2026-07-05T09:00:00+00:00",
  "request_id": "req_..."
}

Ответ report_ready

{
  "id": 42,
  "status": "active",
  "runs": [{
    "status": "completed",
    "changed": true,
    "changes": { "items": [{ "text": "Риск-индекс изменился: 12 → 32." }] },
    "act_pdf_url": "https://realiq.ru/reports/monitor-42-run-7.pdf"
  }]
}

Пример ошибки

{
  "error_code": "invalid_monitor_schedule",
  "message": "Для interval укажите cycles_left или until.",
  "request_id": "req_..."
}

Что списывается с баланса

Каждый боевой цикл списывает 60% стоимости обычной проверки того же типа. Создание подписки само по себе не списывает баланс.

Какие поля доказательного блока вернутся

evidence_root_hash цикла
act_pdf_url
changed/changes
risk_before/risk_after