Hanzo
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

Addresshttps://api.hanzo.ai/v1/o11y/dashboards
MethodGET
OperationListDashboardsV2
AuthAuthorization: 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.

FieldInTypeRequiredDescription
queryquerystringQuery is the filter DSL over dashboard columns and tags, e.g.
sortquerystringSort is the sort field: updated_at, created_at or name.
orderquerystringOrder is the sort direction: asc or desc.
limitqueryintegerLimit caps how many dashboards come back.
offsetqueryintegerOffset is how many dashboards to skip for pagination.

Response

StatusBodyMeaning
200o11y.O11yDashboardListOutok

200 body — 25 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yDashboardList
data.dashboardsbodyo11y.O11yDashboardListItem[]Dashboards are the rows for this page.
data.dashboards[].createdAtbodystring (date-time)CreatedAt is when the dashboard was created.
data.dashboards[].createdBybodystringCreatedBy is who created it.
data.dashboards[].idbodystringID is the dashboard's id.
data.dashboards[].imagebodystringImage is an optional cover image reference.
data.dashboards[].lockedbodybooleanLocked reports whether the dashboard is locked against edits.
data.dashboards[].namebodystringName is the dashboard's unique internal name.
data.dashboards[].orgIdbodystringOrgID is the org the dashboard belongs to.
data.dashboards[].schemaVersionbodystringSchemaVersion is the dashboard schema version.
data.dashboards[].sourcebodystringSource is where the dashboard came from: user, system or integration.
data.dashboards[].specbodyo11y.O11yDashboardListSpec
data.dashboards[].spec.displaybodyo11y.O11yDashboardDisplay
data.dashboards[].spec.display.descriptionbodystringDescription says what the dashboard is for.
data.dashboards[].spec.display.namebodystringName is the human-facing dashboard name.
data.dashboards[].tagsbodyo11y.O11yDashboardTag[]Tags are the dashboard's tags.
data.dashboards[].tags[].keybodystringKey is the tag key.
data.dashboards[].tags[].valuebodystringValue is the tag value.
data.dashboards[].updatedAtbodystring (date-time)UpdatedAt is when it last changed.
data.dashboards[].updatedBybodystringUpdatedBy is who last changed it.
data.tagsbodyo11y.O11yDashboardTag[]Tags are all tags in use across the org's dashboards.
data.tags[].keybodystringKey is the tag key.
data.tags[].valuebodystringValue is the tag value.
data.totalbodyintegerTotal is the count across all pages.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y dashboards list

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page