OpenapiO11y
Returns a page of v2-shape dashboards for the org.
Returns a page of v2-shape dashboards for the org.
GET /v1/o11y/dashboards
| Address | https://api.hanzo.ai/v1/o11y/dashboards |
| Method | GET |
| Operation | ListDashboardsV2 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns a page of v2-shape dashboards for the org. This is the pure, user-independent list — it carries no pin state; use dashboardListForUserV2 for the personalized, pin-aware list. Supports a filter DSL (query), sort (updated_at/created_at/name), order (asc/desc), and offset-based pagination (limit/offset).
Callers need the viewer role; the runtime's own gate enforces it.
Request
5 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
query | query | string | — | Query is the filter DSL over dashboard columns and tags, e.g. |
sort | query | string | — | Sort is the sort field: updated_at, created_at or name. |
order | query | string | — | Order is the sort direction: asc or desc. |
limit | query | integer | — | Limit caps how many dashboards come back. |
offset | query | integer | — | Offset is how many dashboards to skip for pagination. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yDashboardListOut | ok |
200 body — 25 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yDashboardList | — | |
data.dashboards | body | o11y.O11yDashboardListItem[] | — | Dashboards are the rows for this page. |
data.dashboards[].createdAt | body | string (date-time) | — | CreatedAt is when the dashboard was created. |
data.dashboards[].createdBy | body | string | — | CreatedBy is who created it. |
data.dashboards[].id | body | string | — | ID is the dashboard's id. |
data.dashboards[].image | body | string | — | Image is an optional cover image reference. |
data.dashboards[].locked | body | boolean | — | Locked reports whether the dashboard is locked against edits. |
data.dashboards[].name | body | string | — | Name is the dashboard's unique internal name. |
data.dashboards[].orgId | body | string | — | OrgID is the org the dashboard belongs to. |
data.dashboards[].schemaVersion | body | string | — | SchemaVersion is the dashboard schema version. |
data.dashboards[].source | body | string | — | Source is where the dashboard came from: user, system or integration. |
data.dashboards[].spec | body | o11y.O11yDashboardListSpec | — | |
data.dashboards[].spec.display | body | o11y.O11yDashboardDisplay | — | |
data.dashboards[].spec.display.description | body | string | — | Description says what the dashboard is for. |
data.dashboards[].spec.display.name | body | string | — | Name is the human-facing dashboard name. |
data.dashboards[].tags | body | o11y.O11yDashboardTag[] | — | Tags are the dashboard's tags. |
data.dashboards[].tags[].key | body | string | — | Key is the tag key. |
data.dashboards[].tags[].value | body | string | — | Value is the tag value. |
data.dashboards[].updatedAt | body | string (date-time) | — | UpdatedAt is when it last changed. |
data.dashboards[].updatedBy | body | string | — | UpdatedBy is who last changed it. |
data.tags | body | o11y.O11yDashboardTag[] | — | Tags are all tags in use across the org's dashboards. |
data.tags[].key | body | string | — | Key is the tag key. |
data.tags[].value | body | string | — | Value is the tag value. |
data.total | body | integer | — | Total is the count across all pages. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y dashboards listimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listDashboardsV2();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_dashboards_v2()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.ListDashboardsV2(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::list_dashboards_v2(&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).listDashboardsV2();curl https://api.hanzo.ai/v1/o11y/dashboards \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op ListDashboardsV2 — 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": "ListDashboardsV2",
"input": {}
}
}
}'How is this guide?