Skip to main content

Overview

The bigdata_get_monitor tool reads search monitors from your Bigdata.com account. It has three modes depending on what you pass:
  • List mode (no arguments): returns every monitor, as summaries
  • Name mode (name): returns summaries of the monitors whose name contains the given text, ignoring case
  • Fetch mode (id): returns the full detail of one monitor

When to Use

Get Monitor is ideal for:
  • Discovering monitors: Finding out which monitors exist before editing, simulating, or deleting one
  • Resolving an ID: Turning a monitor name into the id required by the other monitor tools
  • Checking configuration: Reading the schedule, entities, schema, and status of a monitor
Never guess a monitor ID. List or search by name first, then fetch by id.

How It Works

  1. List monitors, or search by name
  2. Pick the monitor and take its id
  3. Fetch it with that id to load the full detail

Parameters

Important Notes

  • id and name cannot be sent together
  • List and name mode return summary rows only. Fetch by id for the full detail
  • An unknown monitor id returns a not-found error

Data Returned

structuredContent is always {"monitors": [ ... ]}. List and name mode return one summary row per monitor:
Fetch mode returns the full monitor detail as the only item in monitors.