List metadata

Returns one metric's metadata: description, type, unit, temporality and monotonicity.

GET /v1/o11y/metrics/metadata

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/metrics/metadata`
Method	`GET`
Operation	`GetMetricMetadata`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one metric's metadata: description, type, unit, temporality and monotonicity.

Request

1 field.

Field	In	Type	Required	Description
`metricName`	query	string	yes	MetricName is the metric's name; it may contain slashes, e.g. run.googleapis.com/request_latencies.

Response

Status	Body	Meaning
`200`	o11y.O11yMetricMetadataOut	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 7 fields.

Field	In	Type	Always	Description
`data`	body	o11y.O11yMetricMetadata	—
`data.description`	body	string	—	Description describes the metric.
`data.isMonotonic`	body	boolean	—	IsMonotonic marks a sum that only ever increases.
`data.temporality`	body	string	—	Temporality is delta or cumulative.
`data.type`	body	string	—	Type is the metric type, e.g. gauge, sum, histogram.
`data.unit`	body	string	—	Unit is the metric's unit.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y metrics metadata get --metric-name <metric-name>

.ts

.py

.go

.rs

.java

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMetricMetadata({ metricName: 'metricName' });

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).get_metric_metadata(metric_name='metricName')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.GetMetricMetadata(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::get_metric_metadata(&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).getMetricMetadata();

curl https://api.hanzo.ai/v1/o11y/metrics/metadata?metricName=%3CmetricName%3E \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool o11y, op GetMetricMetadata — 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": "GetMetricMetadata",
           "input": {
             "metricName": "<metricName>"
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList highlights NextGet metric reduction rules