Preview monitor content-filter matches
curl --request POST \
--url https://api.galtea.ai/monitors/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"productId": "prod_123",
"samplingPercentage": 10,
"versionId": "version_123",
"filterQuery": "refund",
"filterTarget": "EITHER",
"excludeQuery": "test, internal",
"excludeTarget": "EITHER",
"days": 90,
"monitorId": "monitor_123"
}
'import requests
url = "https://api.galtea.ai/monitors/preview"
payload = {
"productId": "prod_123",
"samplingPercentage": 10,
"versionId": "version_123",
"filterQuery": "refund",
"filterTarget": "EITHER",
"excludeQuery": "test, internal",
"excludeTarget": "EITHER",
"days": 90,
"monitorId": "monitor_123"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
productId: 'prod_123',
samplingPercentage: 10,
versionId: 'version_123',
filterQuery: 'refund',
filterTarget: 'EITHER',
excludeQuery: 'test, internal',
excludeTarget: 'EITHER',
days: 90,
monitorId: 'monitor_123'
})
};
fetch('https://api.galtea.ai/monitors/preview', 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.galtea.ai/monitors/preview",
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([
'productId' => 'prod_123',
'samplingPercentage' => 10,
'versionId' => 'version_123',
'filterQuery' => 'refund',
'filterTarget' => 'EITHER',
'excludeQuery' => 'test, internal',
'excludeTarget' => 'EITHER',
'days' => 90,
'monitorId' => 'monitor_123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.galtea.ai/monitors/preview"
payload := strings.NewReader("{\n \"productId\": \"prod_123\",\n \"samplingPercentage\": 10,\n \"versionId\": \"version_123\",\n \"filterQuery\": \"refund\",\n \"filterTarget\": \"EITHER\",\n \"excludeQuery\": \"test, internal\",\n \"excludeTarget\": \"EITHER\",\n \"days\": 90,\n \"monitorId\": \"monitor_123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.galtea.ai/monitors/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"productId\": \"prod_123\",\n \"samplingPercentage\": 10,\n \"versionId\": \"version_123\",\n \"filterQuery\": \"refund\",\n \"filterTarget\": \"EITHER\",\n \"excludeQuery\": \"test, internal\",\n \"excludeTarget\": \"EITHER\",\n \"days\": 90,\n \"monitorId\": \"monitor_123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.galtea.ai/monitors/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"productId\": \"prod_123\",\n \"samplingPercentage\": 10,\n \"versionId\": \"version_123\",\n \"filterQuery\": \"refund\",\n \"filterTarget\": \"EITHER\",\n \"excludeQuery\": \"test, internal\",\n \"excludeTarget\": \"EITHER\",\n \"days\": 90,\n \"monitorId\": \"monitor_123\"\n}"
response = http.request(request)
puts response.read_body{
"range": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"candidateCount": 500,
"matchCount": 120,
"sampledCount": 12,
"approximateSampling": true,
"sampledSessions": [
{
"sessionId": "session_123",
"versionId": "version_123",
"createdAt": "2023-11-07T05:31:56Z",
"turnCount": 4,
"matchedText": "I would like a refund for my last order because it arrived damaged…"
}
]
}{
"error": "Error type",
"message": "Error message description"
}{
"error": "Error type",
"message": "Error message description"
}{
"error": "Error type",
"message": "Error message description"
}{
"error": "Error type",
"message": "Error message description"
}Preview monitor content-filter matches
Read-only preview for a CANDIDATE monitor config: how many and which recent past sessions the given content filter and sampling percentage would select, over a trailing window. Runs no evaluations, spends no credits, and writes nothing (no processed marks). Use it while creating or editing a monitor. The match count is exact; for a create preview (no monitorId) the sampled subset is representative, not the exact set the created monitor will draw.
POST
/
monitors
/
preview
Preview monitor content-filter matches
curl --request POST \
--url https://api.galtea.ai/monitors/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"productId": "prod_123",
"samplingPercentage": 10,
"versionId": "version_123",
"filterQuery": "refund",
"filterTarget": "EITHER",
"excludeQuery": "test, internal",
"excludeTarget": "EITHER",
"days": 90,
"monitorId": "monitor_123"
}
'import requests
url = "https://api.galtea.ai/monitors/preview"
payload = {
"productId": "prod_123",
"samplingPercentage": 10,
"versionId": "version_123",
"filterQuery": "refund",
"filterTarget": "EITHER",
"excludeQuery": "test, internal",
"excludeTarget": "EITHER",
"days": 90,
"monitorId": "monitor_123"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
productId: 'prod_123',
samplingPercentage: 10,
versionId: 'version_123',
filterQuery: 'refund',
filterTarget: 'EITHER',
excludeQuery: 'test, internal',
excludeTarget: 'EITHER',
days: 90,
monitorId: 'monitor_123'
})
};
fetch('https://api.galtea.ai/monitors/preview', 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.galtea.ai/monitors/preview",
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([
'productId' => 'prod_123',
'samplingPercentage' => 10,
'versionId' => 'version_123',
'filterQuery' => 'refund',
'filterTarget' => 'EITHER',
'excludeQuery' => 'test, internal',
'excludeTarget' => 'EITHER',
'days' => 90,
'monitorId' => 'monitor_123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.galtea.ai/monitors/preview"
payload := strings.NewReader("{\n \"productId\": \"prod_123\",\n \"samplingPercentage\": 10,\n \"versionId\": \"version_123\",\n \"filterQuery\": \"refund\",\n \"filterTarget\": \"EITHER\",\n \"excludeQuery\": \"test, internal\",\n \"excludeTarget\": \"EITHER\",\n \"days\": 90,\n \"monitorId\": \"monitor_123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.galtea.ai/monitors/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"productId\": \"prod_123\",\n \"samplingPercentage\": 10,\n \"versionId\": \"version_123\",\n \"filterQuery\": \"refund\",\n \"filterTarget\": \"EITHER\",\n \"excludeQuery\": \"test, internal\",\n \"excludeTarget\": \"EITHER\",\n \"days\": 90,\n \"monitorId\": \"monitor_123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.galtea.ai/monitors/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"productId\": \"prod_123\",\n \"samplingPercentage\": 10,\n \"versionId\": \"version_123\",\n \"filterQuery\": \"refund\",\n \"filterTarget\": \"EITHER\",\n \"excludeQuery\": \"test, internal\",\n \"excludeTarget\": \"EITHER\",\n \"days\": 90,\n \"monitorId\": \"monitor_123\"\n}"
response = http.request(request)
puts response.read_body{
"range": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"candidateCount": 500,
"matchCount": 120,
"sampledCount": 12,
"approximateSampling": true,
"sampledSessions": [
{
"sessionId": "session_123",
"versionId": "version_123",
"createdAt": "2023-11-07T05:31:56Z",
"turnCount": 4,
"matchedText": "I would like a refund for my last order because it arrived damaged…"
}
]
}{
"error": "Error type",
"message": "Error message description"
}{
"error": "Error type",
"message": "Error message description"
}{
"error": "Error type",
"message": "Error message description"
}{
"error": "Error type",
"message": "Error message description"
}You are reading the docs of Galtea 5.10. Read this page in the latest version.
Authorizations
Body
application/json
Response
Preview computed successfully
Read-only preview of how many and which recent past sessions a candidate monitor content filter and sampling percentage would select. No evaluations run and no credits are spent.