> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Get Alert by id

GET http://localhost:5173/api/v1/private/alerts/{id}

Get Alert by id

Reference: https://www.comet.com/docs/opik/reference/rest-api/alerts/get-alert-by-id

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

Alert resource

- `webhook` (Webhook_Public, required)
- `id` (string, optional)
- `name` (string, optional)
- `enabled` (boolean, optional)
- `alert_type` (enum, optional)
  - Allowed values: `general`, `slack`, `pagerduty`
- `metadata` (map from string to string, optional)
- `triggers` (list of AlertTrigger_Public, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)
- `project_id` (string, optional) — 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.

## Errors

### 404 Not Found Error

Not Found

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### Webhook_Public

- `url` (string, required)
- `id` (string, optional)
- `name` (string, optional)
- `secret_token` (string, optional)
- `headers` (map from string to string, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)

### AlertTrigger_Public

- `event_type` (enum, required)
  - Allowed values: `trace:errors`, `trace:feedback_score`, `trace_thread:feedback_score`, `prompt:created`, `prompt:committed`, `trace:guardrails_triggered`, `prompt:deleted`, `experiment:finished`, `trace:cost`, `trace:latency`
- `id` (string, optional)
- `alert_id` (string, optional)
- `trigger_configs` (list of AlertTriggerConfig_Public, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)

### AlertTriggerConfig_Public

- `type` (enum, required)
  - Allowed values: `scope:project`, `threshold:feedback_score`, `threshold:cost`, `threshold:latency`, `threshold:errors`, `filter:guardrail_type`
- `id` (string, optional)
- `alert_trigger_id` (string, optional)
- `config_value` (map from string to string, optional)
- `group_index` (integer, optional) — 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.
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)

## Examples

**Response**

```json
{
  "webhook": {
    "url": "string",
    "id": "string",
    "name": "string",
    "secret_token": "string",
    "headers": {},
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "string",
    "last_updated_at": "2024-01-15T09:30:00Z",
    "last_updated_by": "string"
  },
  "id": "string",
  "name": "string",
  "enabled": true,
  "alert_type": "general",
  "metadata": {},
  "triggers": [
    {
      "event_type": "trace:errors",
      "id": "string",
      "alert_id": "string",
      "trigger_configs": [
        {
          "type": "scope:project",
          "id": "string",
          "alert_trigger_id": "string",
          "config_value": {},
          "group_index": 1,
          "created_at": "2024-01-15T09:30:00Z",
          "created_by": "string",
          "last_updated_at": "2024-01-15T09:30:00Z",
          "last_updated_by": "string"
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "string"
    }
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "project_id": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/alerts/id"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/alerts/id';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/alerts/id"

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/alerts/id")

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

request = Net::HTTP::Get.new(url)

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:5173/api/v1/private/alerts/id")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/alerts/id');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/alerts/id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/alerts/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```