Get dashboards — GET /v1/o11y/public/dashboards/{id}

Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes.

GET /v1/o11y/public/dashboards/{id}

Addresshttps://api.hanzo.ai/v1/o11y/public/dashboards/{id}
MethodGET
OperationGetPublicDashboardData
AuthAuthorization: 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.

FieldInTypeRequiredDescription
idpathstringyesID is the resource id from the path.

Response

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

200 body — 16 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yPublicDashboardData—
data.dashboardbodyo11y.O11yPublicDashboardV1—
data.dashboard.createdAtbodystring (date-time)—CreatedAt is when the dashboard was created.
data.dashboard.createdBybodystring—CreatedBy is who created it.
data.dashboard.databodyany—Data is the sanitized widget data as stored, carried verbatim as open JSON.
data.dashboard.idbodystring—ID is the dashboard's id.
data.dashboard.lockedbodyboolean—Locked reports whether the dashboard is locked.
data.dashboard.org_idbodystring—OrgID is the org the dashboard belongs to.
data.dashboard.sourcebodystring—Source is where the dashboard came from.
data.dashboard.updatedAtbodystring (date-time)—UpdatedAt is when it last changed.
data.dashboard.updatedBybodystring—UpdatedBy is who last changed it.
data.publicDashboardbodyo11y.O11yPublicDashboard—
data.publicDashboard.defaultTimeRangebodystring—DefaultTimeRange is the fixed window when the range is not caller-chosen.
data.publicDashboard.publicPathbodystring—PublicPath is the public URL path the share is reachable at.
data.publicDashboard.timeRangeEnabledbodyboolean—TimeRangeEnabled reports whether the public page may pick its own range.
statusbodystring—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 := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.GetPublicDashboardData(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::get_public_dashboard_data(&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).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>"
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?