List Signals

curl --request GET \
  --url https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals \
  --header 'Splunk-AO-API-Key: <api-key>'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals"

headers = {"Splunk-AO-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Splunk-AO-API-Key': '<api-key>'}};

fetch('https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Splunk-AO-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Splunk-AO-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "display_key": "<string>",
      "title": "<string>",
      "description": "<string>",
      "labels": [
        "<string>"
      ],
      "severity_level": "LOW",
      "status": "OPEN",
      "notifications_muted": true,
      "affected_session_count": 1,
      "remediation_summary": {
        "primary_recommendation": {
          "id": "<string>",
          "type": "<string>",
          "title": "<string>",
          "state": "PROPOSED"
        },
        "latest_action": {
          "id": "<string>",
          "type": "<string>",
          "title": "<string>",
          "state": "PROPOSED"
        },
        "recommendation_count": 1,
        "completed_action_count": 1
      },
      "merged_signal_count": 1,
      "last_seen_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "next_cursor": "<string>",
    "total": 1
  },
  "facets": {
    "labels": [
      {
        "label": "<string>",
        "count": 1
      }
    ],
    "open_count": 1,
    "resolved_count": 1,
    "muted_count": 1,
    "active_count": 1,
    "archived_count": 1
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

projects

{project_id}

runs

{run_id}

signals

List Signals

curl --request GET \
  --url https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals \
  --header 'Splunk-AO-API-Key: <api-key>'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals"

headers = {"Splunk-AO-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Splunk-AO-API-Key': '<api-key>'}};

fetch('https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Splunk-AO-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/runs/{run_id}/signals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Splunk-AO-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "display_key": "<string>",
      "title": "<string>",
      "description": "<string>",
      "labels": [
        "<string>"
      ],
      "severity_level": "LOW",
      "status": "OPEN",
      "notifications_muted": true,
      "affected_session_count": 1,
      "remediation_summary": {
        "primary_recommendation": {
          "id": "<string>",
          "type": "<string>",
          "title": "<string>",
          "state": "PROPOSED"
        },
        "latest_action": {
          "id": "<string>",
          "type": "<string>",
          "title": "<string>",
          "state": "PROPOSED"
        },
        "recommendation_count": 1,
        "completed_action_count": 1
      },
      "merged_signal_count": 1,
      "last_seen_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "next_cursor": "<string>",
    "total": 1
  },
  "facets": {
    "labels": [
      {
        "label": "<string>",
        "count": 1
      }
    ],
    "open_count": 1,
    "resolved_count": 1,
    "muted_count": 1,
    "active_count": 1,
    "archived_count": 1
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Splunk-AO-API-Key

string

header

required

Path Parameters

project_id

string<uuid4>

required

run_id

string<uuid4>

required

Query Parameters

string | null

Case-insensitive title and problem search. An exact SIG-N value also matches the display key.

Required string length: 1 - 255

labels

string[]

Match Signals containing any selected label.

Maximum array length: 20

Required string length: 1 - 255

severities

enum<string>[]

Severity levels to include.

Maximum array length: 3

Severity level shown to users and used for notification selection.

Available options:

LOW,

MEDIUM,

HIGH

statuses

enum<string>[]

User-marked states to include. Defaults to open Signals.

Maximum array length: 2

Signal state selected by a user.

Available options:

OPEN,

RESOLVED

notification_state

enum<string>

default:UNMUTED

Notification state to include. Defaults to Signals whose notifications are not muted.

Available options:

UNMUTED,

MUTED,

ALL

view

enum<string> | null

ACTIVE or ARCHIVED tab. When set, this replaces statuses and notification_state filters. Product tab represented by a list request.

Available options:

ACTIVE,

ARCHIVED

last_seen_after

string<date-time> | null

Include Signals last seen at or after this timestamp.

last_seen_before

string<date-time> | null

Include Signals last seen before this timestamp.

cursor

string | null

Cursor returned by the previous page with the same filters.

Required string length: 1 - 2048

limit

integer

default:50

Maximum Signals returned in one page.

Required range: 1 <= x <= 100

Response

Successful Response

data

SignalSummary · object[]

required

Show child attributes

Python SDK

TypeScript SDK

API

List Signals

Authorizations

Path Parameters

Query Parameters

Response