Get Alert by id | Opik Documentation

GET/v1/private/alerts/{id}Get Alert by id

Get Alert by id

Parameters

idstring · uuidpathrequired

Responses

objectAlert_Public

alert_typestring

one of "general", "slack", "pagerduty"

created_atstring · date-time

created_bystring

enabledboolean

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

metadataobject

namestring

maxLength 255 · minLength 0

project_idstring · uuid

Optional project scope for this alert. When set, the alert is scoped to the specified project. Do NOT also provide a 'scope:project' trigger config — the system will create it automatically from this field. Sending both project_id and a scope:project trigger config will result in an error.

triggersarray of object

Show child attributes

Show array items

alert_idstring · uuid

created_atstring · date-time

created_bystring

event_typestringrequired

one of "trace:errors", "trace:feedback_score", "trace_thread:feedback_score", "prompt:created", "prompt:committed", "trace:guardrails_triggered", "prompt:deleted", "experiment:finished", "trace:cost", "trace:latency"

idstring · uuid

trigger_configsarray of object

Show child attributes

Show array items

alert_trigger_idstring · uuid

config_valueobject

created_atstring · date-time

created_bystring

group_indexinteger · int32

Groups configs within a trigger: same group_index means AND between configs, different group_index means OR between groups. Null means a legacy/singleton group of one config. Always null for scope:project configs.

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

typestringrequired

one of "scope:project", "threshold:feedback_score", "threshold:cost", "threshold:latency", "threshold:errors", "filter:guardrail_type"

webhookobjectrequired

Show child attributes

created_atstring · date-time

created_bystring

headersobject

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

namestring

secret_tokenstring

maxLength 250 · minLength 0

urlstringrequired

minLength 1

Example response

{
  "alert_type": "general",
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "metadata": {
    "additionalProp1": "string"
  },
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "triggers": [
    {
      "alert_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "event_type": "experiment:finished",
      "id": "00000000-0000-0000-0000-000000000000",
      "trigger_configs": [
        {
          "alert_trigger_id": "00000000-0000-0000-0000-000000000000",
          "config_value": {
            "additionalProp1": "string"
          },
          "created_at": "2026-06-09T00:00:00Z",
          "created_by": "string",
          "group_index": 0,
          "id": "00000000-0000-0000-0000-000000000000",
          "last_updated_at": "2026-06-09T00:00:00Z",
          "last_updated_by": "string",
          "type": "filter:guardrail_type"
        }
      ]
    }
  ],
  "webhook": {
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "headers": {
      "additionalProp1": "string"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "last_updated_at": "2026-06-09T00:00:00Z",
    "last_updated_by": "string",
    "name": "string",
    "secret_token": "string",
    "url": "string"
  }
}

objectErrorMessage_Public

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

idrequiredpath parameter

curl -X GET 'http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000'

const response = await fetch('http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000");
using var response = await client.SendAsync(request);

{
  "alert_type": "general",
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "metadata": {
    "additionalProp1": "string"
  },
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "triggers": [
    {
      "alert_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "event_type": "experiment:finished",
      "id": "00000000-0000-0000-0000-000000000000",
      "trigger_configs": [
        {
          "alert_trigger_id": "00000000-0000-0000-0000-000000000000",
          "config_value": {
            "additionalProp1": "string"
          },
          "created_at": "2026-06-09T00:00:00Z",
          "created_by": "string",
          "group_index": 0,
          "id": "00000000-0000-0000-0000-000000000000",
          "last_updated_at": "2026-06-09T00:00:00Z",
          "last_updated_by": "string",
          "type": "filter:guardrail_type"
        }
      ]
    }
  ],
  "webhook": {
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "headers": {
      "additionalProp1": "string"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "last_updated_at": "2026-06-09T00:00:00Z",
    "last_updated_by": "string",
    "name": "string",
    "secret_token": "string",
    "url": "string"
  }
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}