Preview draft panel
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/panel/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"context": {
"kind": "existing",
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101"
},
"panel": {
"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
}
}
},
"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"
]
}
}
],
"selections": {
"env": {
"kind": "values",
"values": [
"prod"
]
}
},
"time": {
"from_ms": 1791100800000,
"to_ms": 1791104400000
},
"max_data_points": 100
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/panel/preview?app_key="
payload = {
"context": {
"kind": "existing",
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101"
},
"panel": {
"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
}
}
},
"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"]
}
}
],
"selections": { "env": {
"kind": "values",
"values": ["prod"]
} },
"time": {
"from_ms": 1791100800000,
"to_ms": 1791104400000
},
"max_data_points": 100
}
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({
context: {kind: 'existing', dashboard_id: '01990d7a-9c5b-7ab0-9c18-33e38f6f2101'},
panel: {
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}
}
},
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']}
}
],
selections: {env: {kind: 'values', values: ['prod']}},
time: {from_ms: 1791100800000, to_ms: 1791104400000},
max_data_points: 100
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/panel/preview?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/panel/preview?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([
'context' => [
'kind' => 'existing',
'dashboard_id' => '01990d7a-9c5b-7ab0-9c18-33e38f6f2101'
],
'panel' => [
'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
]
]
],
'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'
]
]
]
],
'selections' => [
'env' => [
'kind' => 'values',
'values' => [
'prod'
]
]
],
'time' => [
'from_ms' => 1791100800000,
'to_ms' => 1791104400000
],
'max_data_points' => 100
]),
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/panel/preview?app_key="
payload := strings.NewReader("{\n \"context\": {\n \"kind\": \"existing\",\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n },\n \"panel\": {\n \"id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\",\n \"title\": \"Request rate\",\n \"grid\": {\n \"x\": 0,\n \"y\": 0,\n \"w\": 12,\n \"h\": 8\n },\n \"datasource_ref\": {\n \"kind\": \"fixed\",\n \"datasource_id\": 10,\n \"datasource_type\": \"prometheus\"\n },\n \"queries\": [\n {\n \"ref_id\": \"A\",\n \"legend_alias\": \"{{env}} requests\",\n \"query\": {\n \"mode\": \"range\",\n \"expr\": \"sum(rate(http_requests_total{env=\\\"${env}\\\"}[5m]))\",\n \"args\": {},\n \"min_step_seconds\": 30\n }\n }\n ],\n \"viz_config\": {\n \"kind\": \"time_series\",\n \"options\": {},\n \"unit\": \"count_per_second\",\n \"decimals\": 2,\n \"threshold\": {\n \"mode\": \"higher_is_worse\",\n \"warning\": 1000,\n \"critical\": 2000\n }\n }\n },\n \"variables\": [\n {\n \"kind\": \"custom\",\n \"name\": \"env\",\n \"label\": \"Environment\",\n \"selection\": {\n \"mode\": \"single\",\n \"include_all\": false\n },\n \"options\": [\n {\n \"text\": \"Production\",\n \"value\": \"prod\"\n },\n {\n \"text\": \"Staging\",\n \"value\": \"staging\"\n }\n ],\n \"default\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n }\n ],\n \"selections\": {\n \"env\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n },\n \"time\": {\n \"from_ms\": 1791100800000,\n \"to_ms\": 1791104400000\n },\n \"max_data_points\": 100\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/panel/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"context\": {\n \"kind\": \"existing\",\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n },\n \"panel\": {\n \"id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\",\n \"title\": \"Request rate\",\n \"grid\": {\n \"x\": 0,\n \"y\": 0,\n \"w\": 12,\n \"h\": 8\n },\n \"datasource_ref\": {\n \"kind\": \"fixed\",\n \"datasource_id\": 10,\n \"datasource_type\": \"prometheus\"\n },\n \"queries\": [\n {\n \"ref_id\": \"A\",\n \"legend_alias\": \"{{env}} requests\",\n \"query\": {\n \"mode\": \"range\",\n \"expr\": \"sum(rate(http_requests_total{env=\\\"${env}\\\"}[5m]))\",\n \"args\": {},\n \"min_step_seconds\": 30\n }\n }\n ],\n \"viz_config\": {\n \"kind\": \"time_series\",\n \"options\": {},\n \"unit\": \"count_per_second\",\n \"decimals\": 2,\n \"threshold\": {\n \"mode\": \"higher_is_worse\",\n \"warning\": 1000,\n \"critical\": 2000\n }\n }\n },\n \"variables\": [\n {\n \"kind\": \"custom\",\n \"name\": \"env\",\n \"label\": \"Environment\",\n \"selection\": {\n \"mode\": \"single\",\n \"include_all\": false\n },\n \"options\": [\n {\n \"text\": \"Production\",\n \"value\": \"prod\"\n },\n {\n \"text\": \"Staging\",\n \"value\": \"staging\"\n }\n ],\n \"default\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n }\n ],\n \"selections\": {\n \"env\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n },\n \"time\": {\n \"from_ms\": 1791100800000,\n \"to_ms\": 1791104400000\n },\n \"max_data_points\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/panel/preview?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 \"context\": {\n \"kind\": \"existing\",\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n },\n \"panel\": {\n \"id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\",\n \"title\": \"Request rate\",\n \"grid\": {\n \"x\": 0,\n \"y\": 0,\n \"w\": 12,\n \"h\": 8\n },\n \"datasource_ref\": {\n \"kind\": \"fixed\",\n \"datasource_id\": 10,\n \"datasource_type\": \"prometheus\"\n },\n \"queries\": [\n {\n \"ref_id\": \"A\",\n \"legend_alias\": \"{{env}} requests\",\n \"query\": {\n \"mode\": \"range\",\n \"expr\": \"sum(rate(http_requests_total{env=\\\"${env}\\\"}[5m]))\",\n \"args\": {},\n \"min_step_seconds\": 30\n }\n }\n ],\n \"viz_config\": {\n \"kind\": \"time_series\",\n \"options\": {},\n \"unit\": \"count_per_second\",\n \"decimals\": 2,\n \"threshold\": {\n \"mode\": \"higher_is_worse\",\n \"warning\": 1000,\n \"critical\": 2000\n }\n }\n },\n \"variables\": [\n {\n \"kind\": \"custom\",\n \"name\": \"env\",\n \"label\": \"Environment\",\n \"selection\": {\n \"mode\": \"single\",\n \"include_all\": false\n },\n \"options\": [\n {\n \"text\": \"Production\",\n \"value\": \"prod\"\n },\n {\n \"text\": \"Staging\",\n \"value\": \"staging\"\n }\n ],\n \"default\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n }\n ],\n \"selections\": {\n \"env\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n },\n \"time\": {\n \"from_ms\": 1791100800000,\n \"to_ms\": 1791104400000\n },\n \"max_data_points\": 100\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"panel_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404",
"run_state": "success",
"time": {
"from_ms": 1791100800000,
"to_ms": 1791104400000
},
"variables": {
"env": {
"kind": "values",
"values": [
"prod"
]
}
},
"refs": [
{
"ref_id": "A",
"state": "success",
"child_request_id": "01HK8XQH7B4N0PQR2S6TVW9X3M",
"execution": {
"status": "success",
"frames": [
{
"schema": {
"fields": [
{
"name": "time",
"type": "time"
},
{
"name": "value",
"type": "number"
}
]
},
"data": {
"values": [
[
1791100800000,
812.4
],
[
1791100860000,
846.1
]
]
}
}
]
}
}
],
"display": {
"kind": "time_series",
"options": {},
"unit": "count_per_second",
"decimals": 2,
"threshold": {
"mode": "higher_is_worse",
"warning": 1000,
"critical": 2000
}
},
"budget": {
"max_concurrency": 6,
"execution_count": 1
}
}
}{
"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
Preview draft panel
Execute a draft panel inline without saving a dashboard revision.
POST
/
monit
/
dashboard
/
panel
/
preview
Preview draft panel
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/panel/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"context": {
"kind": "existing",
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101"
},
"panel": {
"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
}
}
},
"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"
]
}
}
],
"selections": {
"env": {
"kind": "values",
"values": [
"prod"
]
}
},
"time": {
"from_ms": 1791100800000,
"to_ms": 1791104400000
},
"max_data_points": 100
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/panel/preview?app_key="
payload = {
"context": {
"kind": "existing",
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101"
},
"panel": {
"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
}
}
},
"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"]
}
}
],
"selections": { "env": {
"kind": "values",
"values": ["prod"]
} },
"time": {
"from_ms": 1791100800000,
"to_ms": 1791104400000
},
"max_data_points": 100
}
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({
context: {kind: 'existing', dashboard_id: '01990d7a-9c5b-7ab0-9c18-33e38f6f2101'},
panel: {
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}
}
},
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']}
}
],
selections: {env: {kind: 'values', values: ['prod']}},
time: {from_ms: 1791100800000, to_ms: 1791104400000},
max_data_points: 100
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/panel/preview?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/panel/preview?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([
'context' => [
'kind' => 'existing',
'dashboard_id' => '01990d7a-9c5b-7ab0-9c18-33e38f6f2101'
],
'panel' => [
'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
]
]
],
'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'
]
]
]
],
'selections' => [
'env' => [
'kind' => 'values',
'values' => [
'prod'
]
]
],
'time' => [
'from_ms' => 1791100800000,
'to_ms' => 1791104400000
],
'max_data_points' => 100
]),
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/panel/preview?app_key="
payload := strings.NewReader("{\n \"context\": {\n \"kind\": \"existing\",\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n },\n \"panel\": {\n \"id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\",\n \"title\": \"Request rate\",\n \"grid\": {\n \"x\": 0,\n \"y\": 0,\n \"w\": 12,\n \"h\": 8\n },\n \"datasource_ref\": {\n \"kind\": \"fixed\",\n \"datasource_id\": 10,\n \"datasource_type\": \"prometheus\"\n },\n \"queries\": [\n {\n \"ref_id\": \"A\",\n \"legend_alias\": \"{{env}} requests\",\n \"query\": {\n \"mode\": \"range\",\n \"expr\": \"sum(rate(http_requests_total{env=\\\"${env}\\\"}[5m]))\",\n \"args\": {},\n \"min_step_seconds\": 30\n }\n }\n ],\n \"viz_config\": {\n \"kind\": \"time_series\",\n \"options\": {},\n \"unit\": \"count_per_second\",\n \"decimals\": 2,\n \"threshold\": {\n \"mode\": \"higher_is_worse\",\n \"warning\": 1000,\n \"critical\": 2000\n }\n }\n },\n \"variables\": [\n {\n \"kind\": \"custom\",\n \"name\": \"env\",\n \"label\": \"Environment\",\n \"selection\": {\n \"mode\": \"single\",\n \"include_all\": false\n },\n \"options\": [\n {\n \"text\": \"Production\",\n \"value\": \"prod\"\n },\n {\n \"text\": \"Staging\",\n \"value\": \"staging\"\n }\n ],\n \"default\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n }\n ],\n \"selections\": {\n \"env\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n },\n \"time\": {\n \"from_ms\": 1791100800000,\n \"to_ms\": 1791104400000\n },\n \"max_data_points\": 100\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/panel/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"context\": {\n \"kind\": \"existing\",\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n },\n \"panel\": {\n \"id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\",\n \"title\": \"Request rate\",\n \"grid\": {\n \"x\": 0,\n \"y\": 0,\n \"w\": 12,\n \"h\": 8\n },\n \"datasource_ref\": {\n \"kind\": \"fixed\",\n \"datasource_id\": 10,\n \"datasource_type\": \"prometheus\"\n },\n \"queries\": [\n {\n \"ref_id\": \"A\",\n \"legend_alias\": \"{{env}} requests\",\n \"query\": {\n \"mode\": \"range\",\n \"expr\": \"sum(rate(http_requests_total{env=\\\"${env}\\\"}[5m]))\",\n \"args\": {},\n \"min_step_seconds\": 30\n }\n }\n ],\n \"viz_config\": {\n \"kind\": \"time_series\",\n \"options\": {},\n \"unit\": \"count_per_second\",\n \"decimals\": 2,\n \"threshold\": {\n \"mode\": \"higher_is_worse\",\n \"warning\": 1000,\n \"critical\": 2000\n }\n }\n },\n \"variables\": [\n {\n \"kind\": \"custom\",\n \"name\": \"env\",\n \"label\": \"Environment\",\n \"selection\": {\n \"mode\": \"single\",\n \"include_all\": false\n },\n \"options\": [\n {\n \"text\": \"Production\",\n \"value\": \"prod\"\n },\n {\n \"text\": \"Staging\",\n \"value\": \"staging\"\n }\n ],\n \"default\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n }\n ],\n \"selections\": {\n \"env\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n },\n \"time\": {\n \"from_ms\": 1791100800000,\n \"to_ms\": 1791104400000\n },\n \"max_data_points\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/panel/preview?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 \"context\": {\n \"kind\": \"existing\",\n \"dashboard_id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2101\"\n },\n \"panel\": {\n \"id\": \"01990d7a-9c5b-7ab0-9c18-33e38f6f2404\",\n \"title\": \"Request rate\",\n \"grid\": {\n \"x\": 0,\n \"y\": 0,\n \"w\": 12,\n \"h\": 8\n },\n \"datasource_ref\": {\n \"kind\": \"fixed\",\n \"datasource_id\": 10,\n \"datasource_type\": \"prometheus\"\n },\n \"queries\": [\n {\n \"ref_id\": \"A\",\n \"legend_alias\": \"{{env}} requests\",\n \"query\": {\n \"mode\": \"range\",\n \"expr\": \"sum(rate(http_requests_total{env=\\\"${env}\\\"}[5m]))\",\n \"args\": {},\n \"min_step_seconds\": 30\n }\n }\n ],\n \"viz_config\": {\n \"kind\": \"time_series\",\n \"options\": {},\n \"unit\": \"count_per_second\",\n \"decimals\": 2,\n \"threshold\": {\n \"mode\": \"higher_is_worse\",\n \"warning\": 1000,\n \"critical\": 2000\n }\n }\n },\n \"variables\": [\n {\n \"kind\": \"custom\",\n \"name\": \"env\",\n \"label\": \"Environment\",\n \"selection\": {\n \"mode\": \"single\",\n \"include_all\": false\n },\n \"options\": [\n {\n \"text\": \"Production\",\n \"value\": \"prod\"\n },\n {\n \"text\": \"Staging\",\n \"value\": \"staging\"\n }\n ],\n \"default\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n }\n ],\n \"selections\": {\n \"env\": {\n \"kind\": \"values\",\n \"values\": [\n \"prod\"\n ]\n }\n },\n \"time\": {\n \"from_ms\": 1791100800000,\n \"to_ms\": 1791104400000\n },\n \"max_data_points\": 100\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"panel_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2404",
"run_state": "success",
"time": {
"from_ms": 1791100800000,
"to_ms": 1791104400000
},
"variables": {
"env": {
"kind": "values",
"values": [
"prod"
]
}
},
"refs": [
{
"ref_id": "A",
"state": "success",
"child_request_id": "01HK8XQH7B4N0PQR2S6TVW9X3M",
"execution": {
"status": "success",
"frames": [
{
"schema": {
"fields": [
{
"name": "time",
"type": "time"
},
{
"name": "value",
"type": "number"
}
]
},
"data": {
"values": [
[
1791100800000,
812.4
],
[
1791100860000,
846.1
]
]
}
}
]
}
}
],
"display": {
"kind": "time_series",
"options": {},
"unit": "count_per_second",
"decimals": 2,
"threshold": {
"mode": "higher_is_worse",
"warning": 1000,
"critical": 2000
}
},
"budget": {
"max_concurrency": 6,
"execution_count": 1
}
}
}{
"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 | 32 requests/second per account (no per-minute limit) |
| Permissions | Datasources Read (monit) |
Usage
- Use this to check a panel while the user is still editing it: the draft panel and its variables are executed inline, and nothing is written and no revision is created.
contextties the draft to a stored dashboard (existingwithdashboard_id) or to a folder that has no dashboard yet (newwithfolder_id). The caller needs access to that dashboard’s folder or to that folder.- The draft
panelandvariablesare validated like a stored definition (grid, query counts per visualization kind, variable references) and must stay within 1 MiB; a violation fails the call with HTTP 400, or HTTP 413 when a size limit is exceeded. Text panels cannot be previewed. - The response has the same shape as a panel run, without
dashboard_idandrevision. It returns HTTP 200 even when every query failed; readrun_stateand each ref’sstateanderror. max_data_pointsdefaults to 100 and is bounded at 2–5000. At most 6 queries run at the same time. A response larger than 8 MiB is rejected withEntityTooLarge(HTTP 413). The call has a 35-second overall deadline; exceeding it returnsRuntimeTimeout(HTTP 504).
Authorizations
Body
application/json
Execute a draft panel inline, without saving a dashboard revision. The draft panel and variables together must stay within 1 MiB, and the request body within 2 MiB.
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?