OpenapiO11y
Returns the sanitized dashboard data for public access — the read a shared…
Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes.
GET /v1/o11y/public/dashboards/{id}
| Address | https://api.hanzo.ai/v1/o11y/public/dashboards/{id} |
| Method | GET |
| Operation | GetPublicDashboardData |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes.
Anonymous, scoped to the public dashboard's read scope; the runtime's own gate enforces it.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the resource id from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yPublicDashboardDataOut | ok |
200 body — 16 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yPublicDashboardData | — | |
data.dashboard | body | o11y.O11yPublicDashboardV1 | — | |
data.dashboard.createdAt | body | string (date-time) | — | CreatedAt is when the dashboard was created. |
data.dashboard.createdBy | body | string | — | CreatedBy is who created it. |
data.dashboard.data | body | any | — | Data is the sanitized widget data as stored, carried verbatim as open JSON. |
data.dashboard.id | body | string | — | ID is the dashboard's id. |
data.dashboard.locked | body | boolean | — | Locked reports whether the dashboard is locked. |
data.dashboard.org_id | body | string | — | OrgID is the org the dashboard belongs to. |
data.dashboard.source | body | string | — | Source is where the dashboard came from. |
data.dashboard.updatedAt | body | string (date-time) | — | UpdatedAt is when it last changed. |
data.dashboard.updatedBy | body | string | — | UpdatedBy is who last changed it. |
data.publicDashboard | body | o11y.O11yPublicDashboard | — | |
data.publicDashboard.defaultTimeRange | body | string | — | DefaultTimeRange is the fixed window when the range is not caller-chosen. |
data.publicDashboard.publicPath | body | string | — | PublicPath is the public URL path the share is reachable at. |
data.publicDashboard.timeRangeEnabled | body | boolean | — | TimeRangeEnabled reports whether the public page may pick its own range. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y public dashboards get <id>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPublicDashboardData({ id: 'id' });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_public_dashboard_data(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetPublicDashboardData(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_public_dashboard_data(&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).getPublicDashboardData();curl https://api.hanzo.ai/v1/o11y/public/dashboards/<id> \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op GetPublicDashboardData — 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": "GetPublicDashboardData",
"input": {
"id": "<id>"
}
}
}
}'How is this guide?