curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/search?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"query": "checkout latency",
"sort": [
{
"field": "title",
"direction": "asc"
}
],
"p": 1,
"limit": 20
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/search?app_key="
payload = {
"query": "checkout latency",
"sort": [
{
"field": "title",
"direction": "asc"
}
],
"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({
query: 'checkout latency',
sort: [{field: 'title', direction: 'asc'}],
p: 1,
limit: 20
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/search?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/search?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([
'query' => 'checkout latency',
'sort' => [
[
'field' => 'title',
'direction' => 'asc'
]
],
'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/search?app_key="
payload := strings.NewReader("{\n \"query\": \"checkout latency\",\n \"sort\": [\n {\n \"field\": \"title\",\n \"direction\": \"asc\"\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/search?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"checkout latency\",\n \"sort\": [\n {\n \"field\": \"title\",\n \"direction\": \"asc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/search?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 \"query\": \"checkout latency\",\n \"sort\": [\n {\n \"field\": \"title\",\n \"direction\": \"asc\"\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."
}
}Search dashboards
Search dashboards in the requested scope.
curl --request POST \
--url 'https://api.flashcat.cloud/monit/dashboard/search?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"query": "checkout latency",
"sort": [
{
"field": "title",
"direction": "asc"
}
],
"p": 1,
"limit": 20
}
'import requests
url = "https://api.flashcat.cloud/monit/dashboard/search?app_key="
payload = {
"query": "checkout latency",
"sort": [
{
"field": "title",
"direction": "asc"
}
],
"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({
query: 'checkout latency',
sort: [{field: 'title', direction: 'asc'}],
p: 1,
limit: 20
})
};
fetch('https://api.flashcat.cloud/monit/dashboard/search?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/search?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([
'query' => 'checkout latency',
'sort' => [
[
'field' => 'title',
'direction' => 'asc'
]
],
'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/search?app_key="
payload := strings.NewReader("{\n \"query\": \"checkout latency\",\n \"sort\": [\n {\n \"field\": \"title\",\n \"direction\": \"asc\"\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/search?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"checkout latency\",\n \"sort\": [\n {\n \"field\": \"title\",\n \"direction\": \"asc\"\n }\n ],\n \"p\": 1,\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/dashboard/search?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 \"query\": \"checkout latency\",\n \"sort\": [\n {\n \"field\": \"title\",\n \"direction\": \"asc\"\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
querymust contain at least one word; an empty or whitespace-only query fails withInvalidParameter. A dashboard matches when every word appears as a substring of its title or description.- Reading is open to every member of the account.
scopepicks what the search covers:mineis the folders of your teams and the folders you created, plus their descendants;allis every folder of the account. Whenscopeis omitted, account owners, admins and roles with the all-teams view scope getall; other members getmine. Trashed dashboards are never returned. - Sort keys are
titleandupdated_at, at most two and each used once; the default isupdated_atdescending.
Authorizations
Body
Search dashboards across every folder the caller can read. The query must contain at least one word.
Which folders the response covers. mine covers the folders of the caller's teams and the folders the caller created, plus their descendants; all covers every folder of the account. When omitted, it is all for account owners, admins and roles with the all-teams view scope, and mine for other members. Any other value fails with InvalidParameter.
mine, all 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?