Hanzo
OpenapiO11y

Lists the dashboard panels that reference a metric.

Lists the dashboard panels that reference a metric.

GET /v1/o11y/metrics/dashboards

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

Lists the dashboard panels that reference a metric.

Request

1 field.

FieldInTypeRequiredDescription
metricNamequerystringyesMetricName is the metric's name; it may contain slashes, e.g.

Response

StatusBodyMeaning
200o11y.O11yMetricDashboardsOutok

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yMetricDashboards
data.dashboardsbodyo11y.O11yMetricPanel[]Dashboards are the panels referencing the metric.
data.dashboards[].dashboardIdbodystringDashboardID is the dashboard's id.
data.dashboards[].dashboardNamebodystringDashboardName is the dashboard's name.
data.dashboards[].filterBybodystring[]FilterBy are the labels the panel filters the metric by.
data.dashboards[].groupBybodystring[]GroupBy are the labels the panel groups the metric by.
data.dashboards[].panelIdbodystringPanelID is the panel's id.
data.dashboards[].panelNamebodystringPanelName is the panel's name.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics dashboards --metric-name <metric-name>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page