Metrics
Get a metric
GET
Get metric by id or key
Authorizations
Path Parameters
Response
ok
Unit of current_value and of the history values: ms, %, days, s, B/s; null for a bare number (a query result in whatever unit the query returns, or a 1/0 state). Follows from source_type and source_config:
- prometheus: Value: scalar result of the PromQL query, as returned by the query; Observer does not rescale it.
- http: Value: ms: response time in milliseconds. With json_path set: the number extracted from the JSON response at json_path (booleans read as 1/0); unit as in the response.
- tcp: Value: ms: TCP connect time in milliseconds.
- dns: Value: ms: DNS resolve time in milliseconds.
- icmp: Value by interpretation: interpretation=latency (default) → ms: average round-trip time in milliseconds; interpretation=packet_loss → %: percentage of pings lost, 0 to 100; interpretation=reachability → 1 when any ping returned, 0 when none did.
- tls_cert: Value: days: days until the certificate expires.
- grpc: Value by interpretation: interpretation=health_state (default) → 1 when the health check reports SERVING, 0 when NOT_SERVING; interpretation=latency → ms: health check round-trip time in milliseconds.
- websocket: Value by interpretation: interpretation=handshake_latency (default) → ms: handshake time in milliseconds; interpretation=round_trip_latency → ms: message round-trip time in milliseconds; interpretation=connection_success → 1 when the socket opened, 0 when it did not.
- mtls_http: Value: ms: response time in milliseconds (deprecated alias of http). With json_path set: the number extracted from the JSON response at json_path (booleans read as 1/0); unit as in the response.
- database: Value: scalar returned by the read-only query (one row, one column), as returned by the query; Observer does not rescale it.
- otlp: Value: aggregated value of the pushed OTLP data points, in the instrument's own unit.
- cloudwatch: Value: latest CloudWatch datapoint for the chosen statistic, in the metric's CloudWatch unit.
- custom: Value: number returned by the registered probe function, in whatever unit it uses.
- loki: Value: scalar result of the LogQL aggregation, as returned by the query; Observer does not rescale it.
- elasticsearch: Value: value of the named aggregation, as returned by the query; Observer does not rescale it.
- host: Value by metric: metric=cpu (default) → %: CPU utilisation percentage, 0 to 100; metric=memory → %: used memory percentage, 0 to 100; metric=filesystem → %: used disk space percentage of the mountpoint, 0 to 100; metric=network → B/s: network throughput in bytes per second (received + sent); metric=load → 1-minute load average divided by the CPU count.
- datadog: Value: scalar result of the Datadog metrics query over the window, as returned by the query; Observer does not rescale it.
- gcp_monitoring: Value: scalar result of the PromQL query against Cloud Monitoring, as returned by the query; Observer does not rescale it.
- azure_monitor: Value: latest Azure Monitor data point for the chosen aggregation, in the metric's Azure unit.
- manual: Value: no measured value; the status is set by hand or by an open incident.
- heartbeat: Value: s: seconds since the last successful ping.
- alert: Value: worst firing alert as a score: 0 none, 1 degraded, 2 unhealthy.
The status the metric is changing to while its dwell window runs (null when nothing is pending). current_status no_data with pending_status healthy means the probe is answering again and the metric is recovering: it flips once dwell_seconds_to_recover has held.
Available options:
healthy, degraded, unhealthy, no_data, null 
