Create metadata

Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.

POST /v1/o11y/metrics/metadata

Addresshttps://api.hanzo.ai/v1/o11y/metrics/metadata
MethodPOST
OperationUpdateMetricMetadata
AuthAuthorization: Bearer $HANZO_API_KEY

Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
descriptionbodystring—Description describes the metric.
isMonotonicbodyboolean—IsMonotonic marks a sum that only ever increases.
metricNamebodystringyesMetricName is the metric to update.
temporalitybodystring—Temporality is delta or cumulative.
typebodystring—Type is the metric type, e.g. gauge, sum, histogram.
unitbodystring—Unit is the metric's unit.

Response

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

200 body — 1 field.

FieldInTypeAlwaysDescription
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics metadata create --metric-name <metricName>
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.updateMetricMetadata({ 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).update_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.UpdateMetricMetadata(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::update_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).updateMetricMetadata();
curl -X POST https://api.hanzo.ai/v1/o11y/metrics/metadata \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "metricName": "<metricName>"
     }'

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

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?