Skip to main content
POST
Get dashboard outline

Restrictions

Usage

  • Use it to render navigation or to find a panel ID before calling POST /monit/dashboard/panel/run, without downloading queries.
  • With target_id set to a tab ID the whole tab is returned; a section ID returns that tab with only that section and no top panels; a panel ID returns only that panel inside its tab or section. An unknown ID fails with TargetNotFound (HTTP 404).
  • Panel entries carry only the visualization kind and the datasource type, never queries. Datasource variables always report selection as single without all.
  • Reading is open to every member of the account, so dashboards in every folder are visible whichever team the folder belongs to; reading is open to every member of the account, whichever team the folder belongs to; a dashboard in the trash returns DashboardDeleted (HTTP 410).

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Request an outline, optionally narrowed to one tab, section or panel.

dashboard_id
string
required

Canonical UUIDv7 of the dashboard.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
target_id
string

Optional tab, section or panel ID. When set, the response keeps only the branch that contains it, and an unknown ID returns TargetNotFound.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Structural outline of a dashboard — titles, breadcrumbs and visualization kinds, without queries or definitions. Pass target_id to narrow the outline to one tab, section or panel.