Hanzo
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}

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

200 body — 16 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yPublicDashboardData
data.dashboardbodyo11y.O11yPublicDashboardV1
data.dashboard.createdAtbodystring (date-time)CreatedAt is when the dashboard was created.
data.dashboard.createdBybodystringCreatedBy is who created it.
data.dashboard.databodyanyData is the sanitized widget data as stored, carried verbatim as open JSON.
data.dashboard.idbodystringID is the dashboard's id.
data.dashboard.lockedbodybooleanLocked reports whether the dashboard is locked.
data.dashboard.org_idbodystringOrgID is the org the dashboard belongs to.
data.dashboard.sourcebodystringSource is where the dashboard came from.
data.dashboard.updatedAtbodystring (date-time)UpdatedAt is when it last changed.
data.dashboard.updatedBybodystringUpdatedBy is who last changed it.
data.publicDashboardbodyo11y.O11yPublicDashboard
data.publicDashboard.defaultTimeRangebodystringDefaultTimeRange is the fixed window when the range is not caller-chosen.
data.publicDashboard.publicPathbodystringPublicPath is the public URL path the share is reachable at.
data.publicDashboard.timeRangeEnabledbodybooleanTimeRangeEnabled reports whether the public page may pick its own range.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y public dashboards get <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page