List all monitors
Lists monitors in the organization, sorted by name. Only returns monitors that query at least one dataset visible to the caller. Labels are resolved unless exclude=labels.
Parameters
| Property | Type | Location | Description |
|---|---|---|---|
exclude | string | query | Exclude resolved label objects from each monitor response. The labelIds and labelNames fields are still returned. |
label | string[] | query | Filter by label names in your organization. Repeat the parameter for multiple names, for example ?label=prod&label=team-a. Names match case-insensitively after whitespace normalization; duplicates count once. Commas are part of a name, not separators. Reading resources never creates missing labels. |
label | string | query | How to combine label names: any (the default) requires at least one requested label on a resource; all requires every requested label on that same resource. For example, ?label=prod&label=team-a matches either label, while ?label=prod&label=team-a&labelMatch=all requires both. Unknown names have no matches with any and make all return no resources. Without label parameters, labelMatch has no effect. |
label | string[] | query | Return monitors assigned every specified label ID. When combined with label names, both filters must match; labelMatch applies only to names. |
Request
Try itRun this request against your Axiom organization
Credentials stay in this browser tab and are only sent to Axiom when you run the request.
Response
200Monitors visible to the caller.400Bad Request| Property | Type | Description |
|---|---|---|
alert | boolean | Whether to alert when no data is received |
apl | string | APL (Axiom Processing Language) query string used for monitoring. This query defines what data to analyze and how to process it. At least one of aplQuery or mplQuery must be provided. |
column | string | Name of the column to monitor |
compare | number | Number of days to compare for anomaly detection |
description | string | Detailed description of the monitor's purpose |
disabled | boolean | Whether the monitor is currently disabled |
disabled | string | Timestamp until when the monitor should remain disabled |
include | boolean | Whether to include a query chart in triggered notifications |
interval | integer | How frequently the monitor should run, in minutes. Minimum value is 1 minute. |
mpl | string | MPL (Metrics Processing Language) query string for metrics-based monitoring. Use this as an alternative to aplQuery for metrics datasets. At least one of aplQuery or mplQuery must be provided. |
name | stringRequired | Name of the monitor |
notifier | string[] | List of notifier IDs that will receive alerts. Notifiers can be email, Slack, webhook endpoints, etc. |
notify | boolean | Whether to group notifications |
notify | boolean | Whether to send notifications on every check |
operator | string | Comparison operator for threshold checks: - Below: Trigger when value < threshold - BelowOrEqual: Trigger when value <= threshold - Above: Trigger when value > threshold - AboveOrEqual: Trigger when value >= threshold - AboveOrBelow: Trigger when value is outside a range |
range | integer | Time window to evaluate in each check, in minutes. For example, "last 5 minutes of data" |
resolvable | boolean | Whether the alert can be manually resolved |
second | number | Number of seconds to move each run's query window into the past, so data that arrives late is included. For example, with a value of 300, a run at 10:05 queries up to 10:00. |
skip | boolean | Whether to skip resolved alerts |
threshold | number | Threshold value for triggering the alert |
tolerance | number | Tolerance percentage for anomaly detection |
trigger | number | Number of runs among the last triggerFromNRuns runs, including the current one, that must meet the trigger condition for the monitor to trigger.
The current run must always meet it.
For example, set both fields to 3 to trigger only after 3 consecutive runs meet the condition.
If unset or 0, the first run that meets the condition triggers.
Values above triggerFromNRuns are lowered to it when the monitor is saved.
Applies to Threshold and AnomalyDetection monitors.
|
trigger | number | Number of most recent runs, including the current one, that the monitor looks at when deciding whether to trigger.
Has no effect unless triggerAfterNPositiveResults is also set.
Applies to Threshold and AnomalyDetection monitors.
|
type | stringRequired | Type of monitoring check to perform: - Threshold: Compares a numeric value against a threshold - MatchEvent: Looks for specific events or patterns - AnomalyDetection: Identifies unusual patterns based on historical data |
created | string | Timestamp when the monitor was created |
created | string | ID of the user who created the monitor |
created | boolean | true when the MCP server created this monitor |
datasets | string[] | Dataset names referenced by the monitor query. |
id | stringRequired | Unique identifier for the monitor |
label | string[]Required | IDs of labels assigned to this monitor. |
label | string[]Required | Names of assigned labels, including with exclude=labels; [] when unassigned. |
labels | object[] | Resolved labels assigned to this monitor. |
color | objectRequired | |
name | stringRequired | |
type | stringRequired | |
description | string | |
id | stringRequired | |
name | stringRequired | |
last | string | Most recent error encountered while evaluating the monitor. |
updated | string | Timestamp when the monitor was last updated |