List metrics — GET /v1/o11y/metrics

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
startqueryinteger—Start is the start of the window as a Unix timestamp in milliseconds.
endqueryinteger—End is the end of the window as a Unix timestamp in milliseconds.
limitqueryinteger—Limit caps how many metrics come back; unset means 100, at most 5000.
searchTextquerystring—SearchText narrows the page to metric names containing it.
sourcequerystring—Source narrows the page by ingestion source.

Response

StatusBodyMeaning
200o11y.O11yMetricListOutok
202Approvalheld for approval
defaultproblem-detailsrefused

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yMetricList—
data.metricsbodyo11y.O11yMetricSummary[]—Metrics are the metrics, with their metadata.
data.metrics[].descriptionbodystring—Description describes the metric.
data.metrics[].isMonotonicbodyboolean—IsMonotonic marks a sum that only ever increases.
data.metrics[].metricNamebodystring—MetricName is the metric's name.
data.metrics[].temporalitybodystring—Temporality is delta or cumulative.
data.metrics[].typebodystring—Type is the metric type, e.g. gauge, sum, histogram.
data.metrics[].unitbodystring—Unit is the metric's unit.
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics get
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listMetrics();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).list_metrics()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.ListMetrics(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::list_metrics(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).listMetrics();
curl https://api.hanzo.ai/v1/o11y/metrics \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool o11y, op ListMetrics — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "ListMetrics",
           "input": {}
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?