Get monitor by ID

Get a specific monitor by ID. See Monitors.

GET /monitors/{id}

Get monitor by ID

cURL

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

import requests

url = "https://api.galtea.ai/monitors/{id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.galtea.ai/monitors/{id}', 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/{id}",
  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/{id}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.galtea.ai/monitors/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/monitors/{id}")

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

200

{
  "productId": "prod_123",
  "name": "Production quality watch",
  "metricGroupIds": [
    "metricGroup_123"
  ],
  "id": "monitor_123",
  "versionId": "version_123",
  "userId": "user_123",
  "samplingPercentage": 10,
  "monthlyCreditCap": 500,
  "filterQuery": "refund, cancel, chargeback",
  "filterTarget": "EITHER",
  "excludeQuery": "test, internal",
  "excludeTarget": "EITHER",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

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

id · string · required

Monitor ID

Response

200

application/json

Monitor retrieved successfully

productId · string · required

Example:

"prod_123"

name · string · required

Example:

"Production quality watch"

metricGroupIds · string[] · required

Metric families (Metric.metricGroupId) the monitor scores with. The monitor binds the family, not a specific revision, so revising a metric is picked up automatically without editing the monitor.

Example:

["metricGroup_123"]

id · string

Example:

"monitor_123"

versionId · string | null

Optional version to narrow the monitor to. When null the monitor watches the whole product.

Example:

"version_123"

userId · string | null

Example:

"user_123"

samplingPercentage · number · default: 10

Percentage of production sessions to evaluate (greater than 0, at most 100).

Required range: 0 < x <= 100

Example:

10

monthlyCreditCap · integer | null

Optional monthly credit ceiling for this monitor. When set it must be a positive integer; it may exceed the organization monthly allocation (spend is clamped to the available balance). Null means uncapped.

Required range: x >= 1

Example:

500

filterQuery · string | null

Optional content gate. Comma-separated terms; a session matches when at least one turn whose chosen target (filterTarget) contains ANY term (case-insensitive). Only matching sessions are sampled and evaluated; other sessions are skipped, spending no credits. Max 500 chars. Must be set together with filterTarget. Null means watch every session.

Maximum string length: 500

Example:

"refund, cancel, chargeback"

filterTarget · enum<string> | null

Which side of a turn filterQuery is matched against: INPUT (the user turn), OUTPUT (the agent turn), or EITHER. Must be set together with filterQuery.

Available options: INPUT, OUTPUT, EITHER

Example:

"EITHER"

excludeQuery · string | null

Optional exclude gate. Comma-separated terms; a session is dropped when at least one turn whose chosen target (excludeTarget) contains ANY term (case-insensitive). Applied on top of filterQuery: a session is watched only when it passes filterQuery (if set) AND is not hit by excludeQuery. Max 500 chars. Must be set together with excludeTarget. Null means exclude nothing.

Maximum string length: 500

Example:

"test, internal"

excludeTarget · enum<string> | null

Which side of a turn excludeQuery is matched against: INPUT (the user turn), OUTPUT (the agent turn), or EITHER. Must be set together with excludeQuery.

Available options: INPUT, OUTPUT, EITHER

Example:

"EITHER"

status · enum<string> · default: ACTIVE

Users may set ACTIVE or PAUSED; CAPPED, NO_CREDITS and FAILING are system-set by the scanner and rejected on user writes.

Available options: ACTIVE, PAUSED, CAPPED, NO_CREDITS, FAILING

Example:

"ACTIVE"

createdAt · string<date-time>

deletedAt · string<date-time> | null