Hanzo
OpenapiO11y

Is dashboardListV2 personalized for the calling user: each dashboard carries…

Is dashboardListV2 personalized for the calling user: each dashboard carries the caller's pinned state, and pinned dashboards float to the top of the…

GET /v1/o11y/users/me/dashboards

Addresshttps://api.hanzo.ai/v1/o11y/users/me/dashboards
MethodGET
OperationListDashboardsForUserV2
AuthAuthorization: Bearer $HANZO_API_KEY

Is dashboardListV2 personalized for the calling user: each dashboard carries the caller's pinned state, and pinned dashboards float to the top of the requested ordering. Supports the same filter DSL, sort, order and pagination.

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.O11yDashboardListForUserOutok

200 body — 26 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yDashboardListForUser
data.dashboardsbodyo11y.O11yDashboardListItemForUser[]Dashboards are the rows for this page, each with the caller's pin state.
data.dashboards[].createdAtbodystring (date-time)
data.dashboards[].createdBybodystring
data.dashboards[].idbodystring
data.dashboards[].imagebodystring
data.dashboards[].lockedbodyboolean
data.dashboards[].namebodystring
data.dashboards[].orgIdbodystring
data.dashboards[].pinnedbodybooleanPinned reports whether the calling user has pinned this dashboard.
data.dashboards[].schemaVersionbodystring
data.dashboards[].sourcebodystring
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[]
data.dashboards[].tags[].keybodystringKey is the tag key.
data.dashboards[].tags[].valuebodystringValue is the tag value.
data.dashboards[].updatedAtbodystring (date-time)
data.dashboards[].updatedBybodystring
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 users me dashboards list

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page