Hanzo
OpenapiO11y

Lists the distinct metric names seen in a time range, each with its…

Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.

GET /v1/o11y/metrics

Addresshttps://api.hanzo.ai/v1/o11y/metrics
MethodGET
OperationListMetrics
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.

Request

5 fields.

FieldInTypeRequiredDescription
startqueryintegerStart is the start of the window as a Unix timestamp in milliseconds.
endqueryintegerEnd is the end of the window as a Unix timestamp in milliseconds.
limitqueryintegerLimit caps how many metrics come back; unset means 100, at most 5000.
searchTextquerystringSearchText narrows the page to metric names containing it.
sourcequerystringSource narrows the page by ingestion source.

Response

StatusBodyMeaning
200o11y.O11yMetricListOutok

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yMetricList
data.metricsbodyo11y.O11yMetricSummary[]Metrics are the metrics, with their metadata.
data.metrics[].descriptionbodystringDescription describes the metric.
data.metrics[].isMonotonicbodybooleanIsMonotonic marks a sum that only ever increases.
data.metrics[].metricNamebodystringMetricName is the metric's name.
data.metrics[].temporalitybodystringTemporality is delta or cumulative.
data.metrics[].typebodystringType is the metric type, e.g.
data.metrics[].unitbodystringUnit is the metric's unit.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics get

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page