Get monitors
Get list of monitors with pagination and filtering. See Monitors.
Authorizations
API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....
Query Parameters
Filter by monitor IDs
Filter by product IDs
Filter by version IDs
Filter by monitor names (exact match, multiple)
Filter by monitor name (partial match)
Filter by monitor statuses
ACTIVE, PAUSED, CAPPED, NO_CREDITS, FAILING Filter by bound metric family IDs (Metric.metricGroupId)
Sort instructions (field and direction pairs)
Maximum number of results
Number of results to skip
Filter monitors created at or after this timestamp (ISO 8601 format)
Filter monitors created at or before this timestamp (ISO 8601 format)
Response
Monitors retrieved successfully
"prod_123"
"Production quality watch"
Metric families (Metric.metricGroupId) the monitor scores with. The monitor binds the family, not a specific revision, so revising a metric is picked up automatically without editing the monitor.
["metricGroup_123"]"monitor_123"
Optional version to narrow the monitor to. When null the monitor watches the whole product.
"version_123"
"user_123"
Percentage of production sessions to evaluate (greater than 0, at most 100).
0 < x <= 10010
Optional monthly credit ceiling for this monitor. When set it must be a positive integer; it may exceed the organization monthly allocation (spend is clamped to the available balance). Null means uncapped.
x >= 1500
Minutes of inactivity after which a session is considered complete and eligible for evaluation.
x >= 15
Users may set ACTIVE or PAUSED; CAPPED, NO_CREDITS and FAILING are system-set by the scanner and rejected on user writes.
ACTIVE, PAUSED, CAPPED, NO_CREDITS, FAILING "ACTIVE"