Get dashboard detail
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/get?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101"
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/get?app_key="
payload = { "dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101" }
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'})
};
fetch('https://api.flashcat.cloud/monit/dashboard/get?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/get?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'
]),
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/get?app_key="
payload := strings.NewReader("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\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/get?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/get?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}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"schema_version": "dashboard.v1",
"revision": 7,
"folder_id": 12,
"folder_breadcrumb": [
"Production",
"Checkout"
],
"definition": {
"title": "Checkout service overview",
"description": "Traffic, errors and dependencies for the checkout service.",
"default_time_range": {
"from": "now-1h",
"to": "now"
},
"refresh_interval": "1m",
"variables": [
{
"kind": "custom",
"name": "env",
"label": "Environment",
"selection": {
"mode": "single",
"include_all": false
},
"options": [
{
"text": "Production",
"value": "prod"
},
{
"text": "Staging",
"value": "staging"
}
],
"default": {
"kind": "values",
"values": [
"prod"
]
}
}
],
"tabs": [
{
"id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2202",
"title": "Overview",
"description": "Golden signals.",
"top_panels": [],
"sections": [
{
"id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2303",
"title": "Traffic",
"description": "Request rate and latency.",
"collapsed": false,
"panels": [
{
"id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404",
"title": "Request rate",
"grid": {
"x": 0,
"y": 0,
"w": 12,
"h": 8
},
"datasource_ref": {
"kind": "fixed",
"datasource_id": 10,
"datasource_type": "prometheus"
},
"queries": [
{
"ref_id": "A",
"legend_alias": "{{env}} requests",
"query": {
"mode": "range",
"expr": "sum(rate(http_requests_total{env=\"${env}\"}[5m]))",
"args": {},
"min_step_seconds": 30
}
}
],
"viz_config": {
"kind": "time_series",
"options": {},
"unit": "count_per_second",
"decimals": 2,
"threshold": {
"mode": "higher_is_worse",
"warning": 1000,
"critical": 2000
}
}
}
]
}
]
}
]
},
"created_by": {
"id": 10023,
"name": "Ada Lovelace"
},
"updated_by": {
"id": 10088,
"name": "Grace Hopper"
},
"created_at": 1791000000,
"updated_at": 1791100800,
"writable": true
}
}{
"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."
}
}Dashboards
Get dashboard detail
Fetch one dashboard with its full definition.
POST
/
monit
/
dashboard
/
get
Get dashboard detail
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/get?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101"
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/get?app_key="
payload = { "dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101" }
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'})
};
fetch('https://api.flashcat.cloud/monit/dashboard/get?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/get?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'
]),
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/get?app_key="
payload := strings.NewReader("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\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/get?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/get?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}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"schema_version": "dashboard.v1",
"revision": 7,
"folder_id": 12,
"folder_breadcrumb": [
"Production",
"Checkout"
],
"definition": {
"title": "Checkout service overview",
"description": "Traffic, errors and dependencies for the checkout service.",
"default_time_range": {
"from": "now-1h",
"to": "now"
},
"refresh_interval": "1m",
"variables": [
{
"kind": "custom",
"name": "env",
"label": "Environment",
"selection": {
"mode": "single",
"include_all": false
},
"options": [
{
"text": "Production",
"value": "prod"
},
{
"text": "Staging",
"value": "staging"
}
],
"default": {
"kind": "values",
"values": [
"prod"
]
}
}
],
"tabs": [
{
"id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2202",
"title": "Overview",
"description": "Golden signals.",
"top_panels": [],
"sections": [
{
"id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2303",
"title": "Traffic",
"description": "Request rate and latency.",
"collapsed": false,
"panels": [
{
"id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404",
"title": "Request rate",
"grid": {
"x": 0,
"y": 0,
"w": 12,
"h": 8
},
"datasource_ref": {
"kind": "fixed",
"datasource_id": 10,
"datasource_type": "prometheus"
},
"queries": [
{
"ref_id": "A",
"legend_alias": "{{env}} requests",
"query": {
"mode": "range",
"expr": "sum(rate(http_requests_total{env=\"${env}\"}[5m]))",
"args": {},
"min_step_seconds": 30
}
}
],
"viz_config": {
"kind": "time_series",
"options": {},
"unit": "count_per_second",
"decimals": 2,
"threshold": {
"mode": "higher_is_worse",
"warning": 1000,
"critical": 2000
}
}
}
]
}
]
}
]
},
"created_by": {
"id": 10023,
"name": "Ada Lovelace"
},
"updated_by": {
"id": 10088,
"name": "Grace Hopper"
},
"created_at": 1791000000,
"updated_at": 1791100800,
"writable": true
}
}{
"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."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | None — any valid app_key can call this operation |
Usage
- Reading is open to every member of the account, so dashboards in every folder are visible whichever team the folder belongs to. An unknown dashboard ID, or one from another account, returns
DashboardNotFound(HTTP 404). - A dashboard in the trash returns
DashboardDeleted(HTTP 410) instead of its definition; find it withPOST /monit/dashboard/trash/listand bring it back withPOST /monit/dashboard/restore. - Send the returned
revisionasexpected_revisionon the next update, move or delete.
Authorizations
Body
application/json
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.
Was this page helpful?