curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/outline?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"target_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404"
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/outline?app_key="
payload = {
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"target_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
dashboard_id: '01990d7a-9c5b-7ab0-9c18-33e38f6f2101',
target_id: '01990d7a-9c5b-7ab0-9c18-33e38f6f2404'
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/outline?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/monit/dashboard/outline?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dashboard_id' => '01990d7a-9c5b-7ab0-9c18-33e38f6f2101',
'target_id' => '01990d7a-9c5b-7ab0-9c18-33e38f6f2404'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/monit/dashboard/outline?app_key="
payload := strings.NewReader("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\",\n \"target_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/monit/dashboard/outline?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\",\n \"target_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/outline?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\",\n \"target_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
]
}
]
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "ResourceNotFound",
"message": "The resource you request is not found"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Get dashboard outline
Get a dashboard’s structure without queries or definitions.
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/outline?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"target_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404"
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/outline?app_key="
payload = {
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"target_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
dashboard_id: '01990d7a-9c5b-7ab0-9c18-33e38f6f2101',
target_id: '01990d7a-9c5b-7ab0-9c18-33e38f6f2404'
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/outline?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/monit/dashboard/outline?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dashboard_id' => '01990d7a-9c5b-7ab0-9c18-33e38f6f2101',
'target_id' => '01990d7a-9c5b-7ab0-9c18-33e38f6f2404'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/monit/dashboard/outline?app_key="
payload := strings.NewReader("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\",\n \"target_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/monit/dashboard/outline?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\",\n \"target_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/outline?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\",\n \"target_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
]
}
]
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "ResourceNotFound",
"message": "The resource you request is not found"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Authorizations
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.
Body
Request an outline, optionally narrowed to one tab, section or panel.
Canonical UUIDv7 of the dashboard.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Optional tab, section or panel ID. When set, the response keeps only the branch that contains it, and an unknown ID returns TargetNotFound.
^[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.
Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.
"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
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.
Show child attributes
Show child attributes
Was this page helpful?