List a monitor's alerts

curl --request GET \
  --url https://api.galtea.ai/monitors/{monitorId}/alerts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.galtea.ai/monitors/{monitorId}/alerts', 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/{monitorId}/alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.galtea.ai/monitors/{monitorId}/alerts"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.galtea.ai/monitors/{monitorId}/alerts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "id": "monitorAlert_123",
    "monitorId": "monitor_123",
    "ruleId": "monitorAlertRule_123",
    "ruleDeletedAt": "2023-11-07T05:31:56Z",
    "state": "OPEN",
    "openedAt": "2023-11-07T05:31:56Z",
    "closedAt": "2023-11-07T05:31:56Z",
    "closeReason": null,
    "window": "ONE_HOUR",
    "windowStart": "2023-11-07T05:31:56Z",
    "windowEnd": "2023-11-07T05:31:56Z",
    "metricGroupId": "metricGroup_123",
    "metricId": "metric_123",
    "specificationId": null,
    "specificationName": "Refunds follow the 30-day policy",
    "families": [
      {
        "metricGroupId": "metricGroup_123",
        "metricId": "metric_123",
        "sampleSize": 40,
        "matchCount": 5
      }
    ],
    "samplingPercentage": 5,
    "threshold": 10,
    "clearValue": 6,
    "observation": {
      "type": "BAD_SESSION_COUNT",
      "badSessionScore": 0.5,
      "badSessionCount": 12,
      "scoredSessionCount": 240
    }
  }
]

{
  "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"
}

GET

monitors

{monitorId}

alerts

List a monitor's alerts

curl --request GET \
  --url https://api.galtea.ai/monitors/{monitorId}/alerts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.galtea.ai/monitors/{monitorId}/alerts', 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/{monitorId}/alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.galtea.ai/monitors/{monitorId}/alerts"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.galtea.ai/monitors/{monitorId}/alerts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "id": "monitorAlert_123",
    "monitorId": "monitor_123",
    "ruleId": "monitorAlertRule_123",
    "ruleDeletedAt": "2023-11-07T05:31:56Z",
    "state": "OPEN",
    "openedAt": "2023-11-07T05:31:56Z",
    "closedAt": "2023-11-07T05:31:56Z",
    "closeReason": null,
    "window": "ONE_HOUR",
    "windowStart": "2023-11-07T05:31:56Z",
    "windowEnd": "2023-11-07T05:31:56Z",
    "metricGroupId": "metricGroup_123",
    "metricId": "metric_123",
    "specificationId": null,
    "specificationName": "Refunds follow the 30-day policy",
    "families": [
      {
        "metricGroupId": "metricGroup_123",
        "metricId": "metric_123",
        "sampleSize": 40,
        "matchCount": 5
      }
    ],
    "samplingPercentage": 5,
    "threshold": 10,
    "clearValue": 6,
    "observation": {
      "type": "BAD_SESSION_COUNT",
      "badSessionScore": 0.5,
      "badSessionCount": 12,
      "scoredSessionCount": 240
    }
  }
]

{
  "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"
}

Authorizations

Authorization

string

header

required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

monitorId

string

required

Monitor ID

Example:

"monitor_123"

Query Parameters

state

enum<string>

Only open or only closed alerts

Available options:

OPEN,

CLOSED

Example:

"OPEN"

ruleIds

string[]

Only alerts opened by these rules

from

string<date-time>

Only alerts still open at or after this time (ISO 8601)

string<date-time>

Only alerts opened at or before this time (ISO 8601)

limit

integer

default:100

Maximum number of results

Required range: 0 <= x <= 1000

offset

integer

default:0

Number of results to skip

Required range: x >= 0

Response

Alerts retrieved successfully

string

required

Example:

"monitorAlert_123"

monitorId

string

required

Example:

"monitor_123"

ruleId

string

required

Example:

"monitorAlertRule_123"

ruleDeletedAt

string<date-time> | null

required

Set when the rule that opened the alert was deleted

state

enum<string>

required

Available options:

OPEN,

CLOSED

Example:

"OPEN"

openedAt

string<date-time>

required

closedAt

string<date-time> | null

required

closeReason

enum<string> | null

required

Available options:

RECOVERED,

RULE_DELETED,

RULE_EDITED,

RULE_PAUSED,

null

Example:

null

window

enum<string>

required

Available options:

FIFTEEN_MINUTES,

ONE_HOUR,

SIX_HOURS,

TWENTY_FOUR_HOURS

Example:

"ONE_HOUR"

windowStart

string<date-time>

required

Start of the window the check counted when the alert opened

windowEnd

string<date-time>

required

End of that window

metricGroupId

string | null

required

The metric family the rule watches; null for an alert on a Specification

Example:

"metricGroup_123"

metricId

string | null

required

The metric revision the check counted; null for an alert on a Specification

Example:

"metric_123"

specificationId

string | null

required

The Specification the rule watches; null for an alert on a metric family

Example:

null

specificationName

string | null

required

The name of the Specification the rule watches, also when it was deleted since; null for an alert on a metric family

Example:

"Refunds follow the 30-day policy"

families

object[]

required

The metric families the check measured when the alert opened, most failures first, at most 50. A Specification alert counts a session once when it fails any of them. Empty for a metric alert opened before Specification alert rules existed.

Show child attributes

samplingPercentage

number | null

required

The monitor's sampling rate

Example:

5

threshold

number

required

The threshold that opened the alert

Example:

10

clearValue

number | null

required

The value at which an open alert closes, from the rule's current settings. A NO_SCORE_RATE alert also needs at least 5 settled sessions in the window to close. Null when the alert is closed, its rule was deleted, or its rule's target, window or bad session score changed. After a threshold-only edit it holds the new clear value.

Example:

6

observation

object

required

What the check saw when the alert opened. The fields depend on the rule type.

Option 1
Option 2

Show child attributes

Overview

Endpoints

List a monitor's alerts

Authorizations

Path Parameters

Query Parameters

Response