Get monitor by ID
Get a specific monitor by ID. 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-....
Path Parameters
Monitor ID
Response
Monitor 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"