OpenapiO11y
Returns one metric's headline numbers: data points, total and active time…
Returns one metric's headline numbers: data points, total and active time series, and when it was last received.
GET /v1/o11y/metrics/highlights
| Address | https://api.hanzo.ai/v1/o11y/metrics/highlights |
| Method | GET |
| Operation | GetMetricHighlights |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one metric's headline numbers: data points, total and active time series, and when it was last received.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
metricName | query | string | yes | MetricName is the metric's name; it may contain slashes, e.g. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yMetricHighlightsOut | ok |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yMetricHighlights | — | |
data.activeTimeSeries | body | integer | — | ActiveTimeSeries is how many of them are active. |
data.dataPoints | body | integer | — | DataPoints is how many data points the metric has. |
data.lastReceived | body | integer | — | LastReceived is when the metric last arrived, as a Unix timestamp in milliseconds. |
data.totalTimeSeries | body | integer | — | TotalTimeSeries is how many time series the metric has ever had. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y metrics highlights --metric-name <metric-name>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMetricHighlights({ 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_highlights(metric_name='metricName')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetMetricHighlights(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_highlights(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).getMetricHighlights();curl https://api.hanzo.ai/v1/o11y/metrics/highlights?metricName=%3CmetricName%3E \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op GetMetricHighlights — 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": "GetMetricHighlights",
"input": {
"metricName": "<metricName>"
}
}
}
}'How is this guide?