> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # Get dashboard outline > Get a dashboard's structure without queries or definitions. ## OpenAPI ````yaml /api-reference/monitors.openapi.en.json post /monit/dashboard/outline openapi: 3.1.0 info: title: Flashduty Open API description: >- Public HTTP API for the Flashduty incident management platform — incidents, notification templates, channels, schedules, monitors, RUM, and platform administration. Every operation is authenticated with an `app_key` query parameter issued from the Flashduty console under Account → APP Keys. Responses follow a uniform envelope: `{ request_id, data }` on success, `{ request_id, error }` on failure. version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: Monitors/Alert rules description: >- Create, manage, and export monitor alert rules. Query rule counters and audit history. - name: Monitors/Data sources description: Manage monitoring data sources used by alert rules to query metrics. - name: Monitors/Diagnostics description: >- Diagnostic and query endpoints used by Flashduty AI SRE — ad-hoc data source queries, log/metric diagnostics, and target-side tool invocation. - name: Monitors/Monitor utilities description: Monitors service activation and data preview utilities. - name: Monitors/Dashboards description: >- Create, search, version and run Monitors dashboards, and resolve their variables and queries. - name: Monitors/Rule folders description: >- List the monitor folder tree that dashboards and alert rules are organised in. paths: /monit/dashboard/outline: post: tags: - Monitors/Dashboards summary: Get dashboard outline description: Get a dashboard's structure without queries or definitions. operationId: monit-dashboard-read-outline requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DashboardOutlineRequest' example: dashboard_id: 01990d7a-9c5b-7ab0-9c18-33e38f6f2101 target_id: 01990d7a-9c5b-7ab0-9c18-33e38f6f2404 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/DashboardOutline' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: dashboard: dashboard_id: 01990d7a-9c5b-7ab0-9c18-33e38f6f2101 title: Checkout service overview description: Traffic, errors and dependencies for the checkout service. revision: 7 updated_at: 1791100800 folder: folder_id: 12 breadcrumb: - Production - Checkout variables: - name: env label: Environment kind: custom selection: mode: single include_all: false tabs: - id: 01990d7a-9c5b-7ab0-9c18-33e38f6f2202 title: Overview description: Golden signals. breadcrumb: - Checkout service overview - Overview top_panels: [] sections: - id: 01990d7a-9c5b-7ab0-9c18-33e38f6f2303 title: Traffic description: Request rate and latency. breadcrumb: - Checkout service overview - Overview - Traffic panels: - id: 01990d7a-9c5b-7ab0-9c18-33e38f6f2404 title: Request rate breadcrumb: - Checkout service overview - Overview - Traffic - Request rate viz_config: kind: time_series datasource_type: prometheus '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: DashboardOutlineRequest: type: object description: Request an outline, optionally narrowed to one tab, section or panel. properties: dashboard_id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: Canonical UUIDv7 of the dashboard. target_id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: >- Optional tab, section or panel ID. When set, the response keeps only the branch that contains it, and an unknown ID returns `TargetNotFound`. required: - dashboard_id SuccessEnvelope: type: object description: >- 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`. properties: request_id: type: string description: >- Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues. example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: Endpoint-specific payload. See each operation's 200 response schema. required: - request_id - data DashboardOutline: type: object description: >- 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. properties: dashboard: $ref: '#/components/schemas/DashboardOutlineInfo' folder: $ref: '#/components/schemas/DashboardOutlineFolder' variables: type: array items: $ref: '#/components/schemas/DashboardOutlineVariable' description: Variable summaries. tabs: type: array items: $ref: '#/components/schemas/DashboardOutlineTab' description: Tabs, narrowed by `target_id` when supplied. required: - dashboard - folder - variables - tabs DashboardOutlineInfo: type: object description: Dashboard-level outline entry. properties: dashboard_id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: Dashboard ID. title: type: string description: Dashboard title. description: type: string description: Dashboard description; empty when unset. revision: type: integer format: uint64 minimum: 1 description: Current revision number. updated_at: type: integer format: int64 description: Unix timestamp in seconds. required: - dashboard_id - title - revision - updated_at DashboardOutlineFolder: type: object description: Folder placement in an outline. properties: folder_id: type: integer format: uint64 minimum: 1 description: Folder ID. breadcrumb: type: array items: type: string description: Folder names from the root. required: - folder_id - breadcrumb DashboardOutlineVariable: type: object description: Variable summary in an outline. properties: name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: Variable name. label: type: string description: Display label; empty when unset. kind: type: string enum: - datasource - custom - query description: >- Variable kind: `datasource` = selects a datasource; `custom` = fixed inline list; `query` = resolved by running a query. selection: $ref: '#/components/schemas/DashboardSelectionConfig' required: - name - kind DashboardOutlineTab: type: object description: Tab entry in an outline, with its breadcrumb. properties: id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: Tab ID. title: type: string description: Tab title. description: type: string description: Tab description; empty when unset. breadcrumb: type: array items: type: string description: Dashboard title followed by the tab title. top_panels: type: array items: $ref: '#/components/schemas/DashboardOutlinePanel' description: Panels placed directly on the tab. sections: type: array items: $ref: '#/components/schemas/DashboardOutlineSection' description: Sections on the tab. required: - id - title - breadcrumb - top_panels - sections ErrorResponse: type: object description: Response envelope for errors. `error` is required; `data` is absent. properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 description: >- Unique trace ID of this request; include it when reporting issues so logs can be located. error: $ref: '#/components/schemas/DutyError' required: - request_id - error DashboardSelectionConfig: type: object description: Selection cardinality for a variable. properties: mode: type: string enum: - single - multi description: >- Selection cardinality: `single` makes the resolved selection hold exactly one value; `multi` allows multiple values. include_all: type: boolean description: When true the variable also offers an `all` selection. required: - mode - include_all DashboardOutlinePanel: type: object description: Panel entry in an outline. properties: id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: Panel ID. title: type: string description: Panel title. description: type: string description: Panel description; empty when unset. breadcrumb: type: array items: type: string description: Full path of titles from the dashboard down to the panel. viz_config: $ref: '#/components/schemas/DashboardOutlineVizConfig' datasource_type: type: string description: >- Datasource type the panel queries; empty when the panel has no datasource (text panels). required: - id - title - breadcrumb - viz_config DashboardOutlineSection: type: object description: Section entry in an outline. properties: id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: Section ID. title: type: string description: Section title. description: type: string description: Section description; empty when unset. breadcrumb: type: array items: type: string description: Dashboard, tab and section titles. panels: type: array items: $ref: '#/components/schemas/DashboardOutlinePanel' description: Panels in the section. required: - id - title - breadcrumb - panels DutyError: type: object description: >- Error payload inside the response envelope. Present only on non-2xx responses. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable error message, localized by the caller's Accept-Language. May contain field names, IDs, or other context from the failing request. example: The specified parameter template_id is not valid. reason: description: >- Optional machine-readable rejection reason, including datasource tool failures. Inspect alongside HTTP status and code. type: string x-flashduty-preserve-absence: true required: - code - message DashboardOutlineVizConfig: type: object description: Visualization kind of an outlined panel. properties: kind: type: string enum: - time_series - table - stat - bar - gauge - logs - text description: >- Visualization kind: `time_series` = time series; `table` = table; `stat` = single value; `bar` = bar chart; `gauge` = gauge; `logs` = log stream; `text` = Markdown text. required: - kind ErrorCode: type: string description: >- Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. | Code | HTTP | Meaning | |---|---|---| | `OK` | 200 | Reserved — not returned on real errors. | | `InvalidParameter` | 400 | A required parameter is missing or failed validation. | | `BadRequest` | 400 | Generic 400 used when no more specific code fits. | | `InvalidContentType` | 400 | The `Content-Type` header is not `application/json`. | | `ResourceNotFound` | 400 | The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). | | `NoLicense` | 400 | The feature is license-gated and no active license was found. | | `ReferenceExist` | 400 | Deletion blocked — other entities still reference this resource. | | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. | | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient account balance. | | `AccessDenied` | 403 | Authenticated but lacking the permission required for this operation. | | `RouteNotFound` | 404 | The request URL path is not a known route. | | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this otherwise-known path. | | `UndonedOrderExist` | 409 | An outstanding billing order blocks this new one. Wait and retry. | | `RequestLocked` | 423 | Operation temporarily locked due to repeated failures. | | `EntityTooLarge` | 413 | Request body exceeds the configured max size. | | `RequestTooFrequently` | 429 | Rate limit hit — API-global, per-account, or per-integration. | | `RequestVerifyRequired` | 428 | Second-factor verification required but not supplied. | | `DangerousOperation` | 428 | High-risk operation requires MFA verification. | | `InternalError` | 500 | Unhandled server-side error. Include `request_id` in the bug report. | | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try again later. | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: Reserved — not returned on real errors. InvalidParameter: A required parameter is missing or failed validation. BadRequest: Generic 400 used when no more specific code fits. InvalidContentType: The `Content-Type` header is not `application/json`. ResourceNotFound: >- The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). NoLicense: The feature is license-gated and no active license was found. ReferenceExist: Deletion blocked — other entities still reference this resource. Unauthorized: '`app_key` is missing, invalid, or expired.' BalanceNotEnough: Billing-gated operation with insufficient account balance. AccessDenied: Authenticated but lacking the permission required for this operation. RouteNotFound: The request URL path is not a known route. MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path. UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry. RequestLocked: Operation temporarily locked due to repeated failures. EntityTooLarge: Request body exceeds the configured max size. RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration. RequestVerifyRequired: Second-factor verification required but not supplied. DangerousOperation: High-risk operation requires MFA verification. InternalError: Unhandled server-side error. Include `request_id` in the bug report. ServiceUnavailable: A backend dependency is unavailable. Try again later. example: InvalidParameter responses: BadRequest: description: Invalid request — usually a missing or malformed parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: Missing or invalid app_key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. Forbidden: description: The app_key is valid but lacks permission for this operation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: noEditPermission: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: AccessDenied message: Access Denied. NotFound: description: >- The referenced resource does not exist or has been deleted. Note: Flashduty historically returns HTTP 400 with code `ResourceNotFound` for missing domain entities; a true 404 is reserved for unknown routes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: resourceMissing: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: ResourceNotFound message: The resource you request is not found TooManyRequests: description: >- Rate limit hit. Either the global API limit, a per-account limit, or a per-integration limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: Unexpected server-side error. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.