Skip to main content

Overview

The bigdata_simulate_monitor tool runs a search monitor without activating it. It has two modes:
  • Flash (default): previews one recent window. No dates, no novelty check, and no email
  • Full: replays the monitor’s scheduled runs over a past period
The tool starts the simulation and returns a simulation_id straight away. Read the results with bigdata_get_monitor_runs.

When to Use

Simulate Monitor is ideal for:
  • Checking a new monitor: Running a flash preview after bigdata_create_monitor and before activating
  • Checking an edit: Previewing the effect of new queries, entities, or schema
  • Backtesting: Replaying the schedule over a past period to see what the monitor would have caught

How It Works

  1. Call bigdata_simulate_monitor with the monitor id, and a mode and dates for a full simulation
  2. Keep the returned simulation_id and mode
  3. Read the results with bigdata_get_monitor_runs, passing the same simulation_id and mode

Parameters

Flash
Full

Important Notes

  • Flash does not accept dates. Sending start_timestamp or end_timestamp with flash returns an error
  • Full requires end_timestamp
  • A full simulation can cover at most 90 runs. The API’s rejection of the period is returned as the error
  • A full simulation emails its result if the monitor already has email delivery set. Flash never sends email
  • An unknown monitor id returns a not-found error

Data Returned

Practical Tips

Start with flash

Run a flash preview first. It is quick and does not send email. Use full only when the user wants to see past results over a specific period.

Watch the retention warning

If retention_warning is set, tell the user that the earliest runs of the period may be missing results because that news is no longer available to the monitor.