Skip to main content
POST
/
monitors
Create monitor
curl --request POST \
  --url https://api.galtea.ai/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "prod_123",
  "name": "Production quality watch",
  "metricGroupIds": [
    "metricGroup_123"
  ],
  "id": "monitor_123",
  "versionId": "version_123",
  "userId": "user_123",
  "samplingPercentage": 10,
  "monthlyCreditCap": 500,
  "inactivityWindowMinutes": 5,
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.galtea.ai/monitors"

payload = {
    "productId": "prod_123",
    "name": "Production quality watch",
    "metricGroupIds": ["metricGroup_123"],
    "id": "monitor_123",
    "versionId": "version_123",
    "userId": "user_123",
    "samplingPercentage": 10,
    "monthlyCreditCap": 500,
    "inactivityWindowMinutes": 5,
    "status": "ACTIVE",
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
}
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',
    name: 'Production quality watch',
    metricGroupIds: ['metricGroup_123'],
    id: 'monitor_123',
    versionId: 'version_123',
    userId: 'user_123',
    samplingPercentage: 10,
    monthlyCreditCap: 500,
    inactivityWindowMinutes: 5,
    status: 'ACTIVE',
    createdAt: '2023-11-07T05:31:56Z',
    deletedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.galtea.ai/monitors', 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",
  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',
    'name' => 'Production quality watch',
    'metricGroupIds' => [
        'metricGroup_123'
    ],
    'id' => 'monitor_123',
    'versionId' => 'version_123',
    'userId' => 'user_123',
    'samplingPercentage' => 10,
    'monthlyCreditCap' => 500,
    'inactivityWindowMinutes' => 5,
    'status' => 'ACTIVE',
    'createdAt' => '2023-11-07T05:31:56Z',
    'deletedAt' => '2023-11-07T05:31:56Z'
  ]),
  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"

	payload := strings.NewReader("{\n  \"productId\": \"prod_123\",\n  \"name\": \"Production quality watch\",\n  \"metricGroupIds\": [\n    \"metricGroup_123\"\n  ],\n  \"id\": \"monitor_123\",\n  \"versionId\": \"version_123\",\n  \"userId\": \"user_123\",\n  \"samplingPercentage\": 10,\n  \"monthlyCreditCap\": 500,\n  \"inactivityWindowMinutes\": 5,\n  \"status\": \"ACTIVE\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": \"prod_123\",\n  \"name\": \"Production quality watch\",\n  \"metricGroupIds\": [\n    \"metricGroup_123\"\n  ],\n  \"id\": \"monitor_123\",\n  \"versionId\": \"version_123\",\n  \"userId\": \"user_123\",\n  \"samplingPercentage\": 10,\n  \"monthlyCreditCap\": 500,\n  \"inactivityWindowMinutes\": 5,\n  \"status\": \"ACTIVE\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"name\": \"Production quality watch\",\n  \"metricGroupIds\": [\n    \"metricGroup_123\"\n  ],\n  \"id\": \"monitor_123\",\n  \"versionId\": \"version_123\",\n  \"userId\": \"user_123\",\n  \"samplingPercentage\": 10,\n  \"monthlyCreditCap\": 500,\n  \"inactivityWindowMinutes\": 5,\n  \"status\": \"ACTIVE\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "productId": "prod_123",
  "name": "Production quality watch",
  "metricGroupIds": [
    "metricGroup_123"
  ],
  "id": "monitor_123",
  "versionId": "version_123",
  "userId": "user_123",
  "samplingPercentage": 10,
  "monthlyCreditCap": 500,
  "inactivityWindowMinutes": 5,
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
{
  "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-....

Body

application/json
​
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

​
inactivityWindowMinutes
integer
default:5

Minutes of inactivity after which a session is considered complete and eligible for evaluation.

Required range: x >= 1
Example:

5

​
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

Response

Monitor created 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

​
inactivityWindowMinutes
integer
default:5

Minutes of inactivity after which a session is considered complete and eligible for evaluation.

Required range: x >= 1
Example:

5

​
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