List recent event samples
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/sample/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131
}
'import requests
url = "https://api.flashcat.cloud/enrichment/sample/list?app_key="
payload = { "integration_id": 6113996590131 }
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({integration_id: 6113996590131})
};
fetch('https://api.flashcat.cloud/enrichment/sample/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/enrichment/sample/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([
'integration_id' => 6113996590131
]),
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/enrichment/sample/list?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131\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/enrichment/sample/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/sample/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 \"integration_id\": 6113996590131\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"received_at": 1792657352,
"event": {
"title": "CPU usage 94% on checkout-7",
"title_rule": "$service::$check",
"description": "CPU usage above 90% for 5 minutes.",
"alert_key": "cpu-usage-high:checkout-7",
"event_status": "Critical",
"event_severity": "Critical",
"event_time": 1792657345,
"labels": {
"check": "cpu",
"env": "prod",
"host": "checkout-7"
},
"images": []
},
"description_truncated": false
}
]
}
}{
"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": "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."
}
}Alert enrichment
List recent event samples
List the raw events an integration received most recently, newest first.
POST
/
enrichment
/
sample
/
list
List recent event samples
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/sample/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131
}
'import requests
url = "https://api.flashcat.cloud/enrichment/sample/list?app_key="
payload = { "integration_id": 6113996590131 }
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({integration_id: 6113996590131})
};
fetch('https://api.flashcat.cloud/enrichment/sample/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/enrichment/sample/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([
'integration_id' => 6113996590131
]),
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/enrichment/sample/list?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131\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/enrichment/sample/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/sample/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 \"integration_id\": 6113996590131\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"received_at": 1792657352,
"event": {
"title": "CPU usage 94% on checkout-7",
"title_rule": "$service::$check",
"description": "CPU usage above 90% for 5 minutes.",
"alert_key": "cpu-usage-high:checkout-7",
"event_status": "Critical",
"event_severity": "Critical",
"event_time": 1792657345,
"labels": {
"check": "cpu",
"env": "prod",
"host": "checkout-7"
},
"images": []
},
"description_truncated": false
}
]
}
}{
"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": "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 | Channels Manage (on-call) or Integrations Read (on-call) or Integrations Manage (on-call) |
Usage
- Samples are the events as they entered enrichment, so they show exactly the labels your rules match on.
- The integration must exist and the caller must be allowed to read it.
- Only the last 20 raw events of an integration are kept, for 7 days; the list is for checking rules, not for searching history.
- A stored sample keeps its description up to 8 KiB (
description_truncatedmarks one that was cut); an event larger than 64 KiB is not kept at all. droppedmarks a sample the integration discarded before it became an alert.
Authorizations
APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.
Body
application/json
Request body of POST /enrichment/sample/list.
Integration whose recent raw events to list.
Required range:
x >= 1Response
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?