Start Manual Signal Scan
curl --request POST \
--url https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans \
--header 'Content-Type: application/json' \
--header 'Splunk-AO-API-Key: <api-key>' \
--data '
{
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"model": "<string>",
"integration_id": "<string>"
}
'import requests
url = "https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans"
payload = {
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"model": "<string>",
"integration_id": "<string>"
}
headers = {
"Splunk-AO-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Splunk-AO-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
window_start: '2023-11-07T05:31:56Z',
window_end: '2023-11-07T05:31:56Z',
model: '<string>',
integration_id: '<string>'
})
};
fetch('https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans', 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.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans",
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([
'window_start' => '2023-11-07T05:31:56Z',
'window_end' => '2023-11-07T05:31:56Z',
'model' => '<string>',
'integration_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Splunk-AO-API-Key: <api-key>"
],
]);
$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.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans"
payload := strings.NewReader("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"model\": \"<string>\",\n \"integration_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Splunk-AO-API-Key", "<api-key>")
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.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans")
.header("Splunk-AO-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"model\": \"<string>\",\n \"integration_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Splunk-AO-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"model\": \"<string>\",\n \"integration_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"scan_number": 2,
"trigger": "ON_DEMAND",
"status": "QUEUED",
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"sampling_strategy": "<string>",
"model": "<string>",
"model_usage": {},
"error": {},
"failure_reason": "<string>",
"eligible_session_count": 1,
"sampled_session_count": 1,
"analyzed_session_count": 1,
"skipped_oversized_session_count": 1,
"sampled_span_count": 1,
"signals_created": 1,
"signals_updated": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}signals-v2
Start Manual Signal Scan
Start one manual Signal scan for a log stream and fixed telemetry window.
POST
/
v2
/
projects
/
{project_id}
/
runs
/
{run_id}
/
signals
/
scans
Start Manual Signal Scan
curl --request POST \
--url https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans \
--header 'Content-Type: application/json' \
--header 'Splunk-AO-API-Key: <api-key>' \
--data '
{
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"model": "<string>",
"integration_id": "<string>"
}
'import requests
url = "https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans"
payload = {
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"model": "<string>",
"integration_id": "<string>"
}
headers = {
"Splunk-AO-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Splunk-AO-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
window_start: '2023-11-07T05:31:56Z',
window_end: '2023-11-07T05:31:56Z',
model: '<string>',
integration_id: '<string>'
})
};
fetch('https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans', 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.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans",
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([
'window_start' => '2023-11-07T05:31:56Z',
'window_end' => '2023-11-07T05:31:56Z',
'model' => '<string>',
'integration_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Splunk-AO-API-Key: <api-key>"
],
]);
$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.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans"
payload := strings.NewReader("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"model\": \"<string>\",\n \"integration_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Splunk-AO-API-Key", "<api-key>")
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.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans")
.header("Splunk-AO-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"model\": \"<string>\",\n \"integration_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals/scans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Splunk-AO-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"model\": \"<string>\",\n \"integration_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"scan_number": 2,
"trigger": "ON_DEMAND",
"status": "QUEUED",
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"sampling_strategy": "<string>",
"model": "<string>",
"model_usage": {},
"error": {},
"failure_reason": "<string>",
"eligible_session_count": 1,
"sampled_session_count": 1,
"analyzed_session_count": 1,
"skipped_oversized_session_count": 1,
"sampled_span_count": 1,
"signals_created": 1,
"signals_updated": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
APIKeyHeaderClassicAPIKeyHeaderOAuth2PasswordBearerHTTPBasic
Body
application/json
Fixed telemetry window requested for one manual Signal scan.
Model alias for this scan. Required when the log stream has no saved configuration; otherwise the configured model is used.
Required string length:
1 - 255Integration selected for this scan's model.
Response
Successful Response
Complete persisted state for one Signal scan.
Show child attributes
Show child attributes
Was this page helpful?