List dashboards
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 12,
"query": "checkout",
"sort": [
{
"field": "updated_at",
"direction": "desc"
}
],
"p": 1,
"limit": 20
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/list?app_key="
payload = {
"folder_id": 12,
"query": "checkout",
"sort": [
{
"field": "updated_at",
"direction": "desc"
}
],
"p": 1,
"limit": 20
}
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({
folder_id: 12,
query: 'checkout',
sort: [{field: 'updated_at', direction: 'desc'}],
p: 1,
limit: 20
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/list?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/list?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([
'folder_id' => 12,
'query' => 'checkout',
'sort' => [
[
'field' => 'updated_at',
'direction' => 'desc'
]
],
'p' => 1,
'limit' => 20
]),
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/list?app_key="
payload := strings.NewReader("{\n \"folder_id\": 12,\n \"query\": \"checkout\",\n \"sort\": [\n {\n \"field\": \"updated_at\",\n \"direction\": \"desc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\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/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 12,\n \"query\": \"checkout\",\n \"sort\": [\n {\n \"field\": \"updated_at\",\n \"direction\": \"desc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/list?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 \"folder_id\": 12,\n \"query\": \"checkout\",\n \"sort\": [\n {\n \"field\": \"updated_at\",\n \"direction\": \"desc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"folder_id": 12,
"folder_breadcrumb": [
"Production",
"Checkout"
],
"title": "Checkout service overview",
"description": "Traffic, errors and dependencies for the checkout service.",
"revision": 7,
"updated_by": {
"id": 10088,
"name": "Grace Hopper"
},
"updated_at": 1791100800,
"writable": true
}
],
"total": 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
List dashboards
List the dashboards stored directly in one folder, with word search and paging.
POST
/
monit
/
dashboard
/
list
List dashboards
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 12,
"query": "checkout",
"sort": [
{
"field": "updated_at",
"direction": "desc"
}
],
"p": 1,
"limit": 20
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/list?app_key="
payload = {
"folder_id": 12,
"query": "checkout",
"sort": [
{
"field": "updated_at",
"direction": "desc"
}
],
"p": 1,
"limit": 20
}
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({
folder_id: 12,
query: 'checkout',
sort: [{field: 'updated_at', direction: 'desc'}],
p: 1,
limit: 20
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/list?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/list?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([
'folder_id' => 12,
'query' => 'checkout',
'sort' => [
[
'field' => 'updated_at',
'direction' => 'desc'
]
],
'p' => 1,
'limit' => 20
]),
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/list?app_key="
payload := strings.NewReader("{\n \"folder_id\": 12,\n \"query\": \"checkout\",\n \"sort\": [\n {\n \"field\": \"updated_at\",\n \"direction\": \"desc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\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/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 12,\n \"query\": \"checkout\",\n \"sort\": [\n {\n \"field\": \"updated_at\",\n \"direction\": \"desc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/list?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 \"folder_id\": 12,\n \"query\": \"checkout\",\n \"sort\": [\n {\n \"field\": \"updated_at\",\n \"direction\": \"desc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"dashboard_id": "01990d7a-9c5b-7ab0-9c18-33e38f6f2101",
"folder_id": 12,
"folder_breadcrumb": [
"Production",
"Checkout"
],
"title": "Checkout service overview",
"description": "Traffic, errors and dependencies for the checkout service.",
"revision": 7,
"updated_by": {
"id": 10088,
"name": "Grace Hopper"
},
"updated_at": 1791100800,
"writable": true
}
],
"total": 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 | 1,000 requests/minute; 50 requests/second per account |
| Permissions | None — any valid app_key can call this operation |
Usage
- Only dashboards stored directly in
folder_idare returned; dashboards in its subfolders are not included. UsePOST /monit/dashboard/searchto look across folders. folder_idmust be an existing folder of the account; reading is open to every member, whatever team the folder belongs to, so only an unknown folder fails, withFolderNotFound(HTTP 404). Trashed dashboards are never listed.queryis split on whitespace; a dashboard matches when every word appears as a substring of its title or description.- Sort keys are
titleandupdated_at, at most two and each used once; the default isupdated_atdescending, and ties are ordered bydashboard_id.
Authorizations
Body
application/json
List the dashboards in one folder. Unlike search, folder_id is required.
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?