Docs
DocumentationQuery ReferenceAPI Reference
Open Console→→
DocumentationQuery ReferenceAPI Reference

Get started

IntroductionSend dataQuery dataPaginationAPI limits

Annotations

List all annotationsGETRetrieve annotationGETCreate annotationPOSTUpdate annotationPUTDelete annotationDELETE

API tokens

List all API tokensGETRetrieve API tokenGETCreate API tokenPOSTRegenerate API tokenPOSTDelete API tokenDELETE

Dashboards

Dashboard JSONList all dashboardsGETRetrieve dashboardGETCreate dashboardPOSTUpdate dashboardPUTPatch dashboard elementPATCHDelete dashboardDELETE

Datasets

List all datasetsGETRetrieve datasetGETList all fields in datasetGETRetrieve field in datasetGETCreate datasetPOSTIngest data (legacy)POSTRun APL query (legacy)POSTRun query (legacy)POSTTrim datasetPOSTUpdate datasetPUTUpdate fieldPUTVacuum datasetPOSTDelete fieldsPOSTDelete fieldDELETEDelete datasetDELETE

Edge

Ingest data to edge deploymentIngest Splunk HEC eventsIngest raw Splunk HEC eventsCheck Splunk HEC healthRun APL query to edge deploymentRun batch query to edge deploymentRun MPL query to edge deploymentGet metrics for a datasetGet metric tags for a datasetGet metric tag values for a datasetGet tags for a datasetGet tag values for a dataset

Labels

List all labelsGETRetrieve labelGETCreate labelPOSTUpdate labelPUTDelete labelDELETEList label assignmentsPOSTReplace label assignmentsPUT

Map fields

List all map fieldsGETCreate map fieldPOSTUpdate list of map fieldsPUTDelete map fieldsDELETE

Monitors

List all monitorsGETRetrieve monitorGETRetrieve monitor notification historyGETCreate monitorPOSTUpdate monitorPUTDelete monitorDELETE

Notifiers

List all notifiersGETRetrieve notifierGETCreate notifierPOSTUpdate notifierPUTDelete notifierDELETE

Organizations

List all orgsGETRetrieve orgGETCreate orgPOSTUpdate orgPUTProvision orgPOST

Role-based access control

List all rolesGETRetrieve roleGETList all groupsGETRetrieve groupGETCreate rolePOSTCreate groupPOSTUpdate rolePUTUpdate groupPUTDelete roleDELETEDelete groupDELETE

Saved queries

List all saved queriesGETRetrieve saved queryGETCreate saved queryPOSTUpdate saved queryPUTDelete saved queryDELETE

Users

Retrieve current userGETList all usersGETRetrieve userGETCreate userPOSTUpdate current userPUTUpdate user rolePUTDelete user from orgDELETE

Views

List all viewsGETRetrieve viewGETCreate viewPOSTUpdate viewPUTDelete viewDELETE

Virtual fields

List all virtual fieldsGETRetrieve virtual fieldGETCreate virtual fieldPOSTUpdate virtual fieldPUTDelete virtual fieldDELETE
Monitors

List all monitors

GET/v2/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.

Info

The API endpoint /v2/monitors only returns monitors for datasets that your API token has query access to. If the API returns an empty list, ensure your token has query permissions for the datasets used by your monitors.

Parameters

PropertyTypeLocationDescription
excludestringqueryExclude resolved label objects from each monitor response. The labelIds and labelNames fields are still returned.
labelstring[]queryFilter 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.
labelMatchstringqueryHow 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.
labelIdsstring[]queryReturn monitors assigned every specified label ID. When combined with label names, both filters must match; labelMatch applies only to names.

Request

curl -X GET 'https://api.axiom.co/v2/monitors' \
  -H 'Authorization: Bearer API_TOKEN'
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.
application/json
400Bad Request
PropertyTypeDescription
alertOnNoDatabooleanWhether to alert when no data is received
aplQuerystringAPL (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.
columnNamestringName of the column to monitor
compareDaysnumber<int64>Number of days to compare for anomaly detection
descriptionstringDetailed description of the monitor's purpose
disabledbooleanWhether the monitor is currently disabled
disabledUntilstring<date-time>Timestamp until when the monitor should remain disabled
includeChartbooleanWhether to include a query chart in triggered notifications
intervalMinutesinteger<int64>How frequently the monitor should run, in minutes. Minimum value is 1 minute.
mplQuerystringMPL (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.
namestringRequiredName of the monitor
notifierIdsstring[]List of notifier IDs that will receive alerts. Notifiers can be email, Slack, webhook endpoints, etc.
notifyByGroupbooleanWhether to group notifications
notifyEveryRunbooleanWhether to send notifications on every check
operatorstringComparison 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
rangeMinutesinteger<int64>Time window to evaluate in each check, in minutes. For example, "last 5 minutes of data"
resolvablebooleanWhether the alert can be manually resolved
secondDelaynumber<int64>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.
skipResolvedbooleanWhether to skip resolved alerts
thresholdnumber<double>Threshold value for triggering the alert
tolerancenumberTolerance percentage for anomaly detection
triggerAfterNPositiveResultsnumber<int64>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.
triggerFromNRunsnumber<int64>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.
typestringRequiredType 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
createdAtstring<date-time>Timestamp when the monitor was created
createdBystringID of the user who created the monitor
createdByAgentbooleantrue when the MCP server created this monitor
datasetsstring[]Dataset names referenced by the monitor query.
idstringRequiredUnique identifier for the monitor
labelIdsstring[]RequiredIDs of labels assigned to this monitor.
labelNamesstring[]RequiredNames of assigned labels, including with exclude=labels; [] when unassigned.
labelsobject[]Resolved labels assigned to this monitor.
└colorobjectRequired—
└namestringRequired—
└typestringRequired—
└descriptionstring—
└idstringRequired—
└namestringRequired—
lastErrorstringMost recent error encountered while evaluating the monitor.
updatedAtstring<date-time>Timestamp when the monitor was last updated
Was this page helpful?
Suggest edits on GitHub
PreviousDelete map fieldsNextRetrieve monitor
On this page
ParametersRequestResponse