For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETFind alerts
        • POSTCreate alert
        • POSTDelete alert batch
        • GETGet Alert by id
        • PUTUpdate alert
        • GETGet webhook payload examples
        • POSTTest alert webhook
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceAlerts

Find alerts

GET
/v1/private/alerts
GET
/api/v1/private/alerts
$curl http://localhost:5173/api/v1/private/alerts
200Retrieved
1{
2  "page": 1,
3  "size": 1,
4  "total": 1,
5  "content": [
6    {
7      "webhook": {
8        "url": "string",
9        "id": "string",
10        "name": "string",
11        "secret_token": "string",
12        "headers": {},
13        "created_at": "2024-01-15T09:30:00Z",
14        "created_by": "string",
15        "last_updated_at": "2024-01-15T09:30:00Z",
16        "last_updated_by": "string"
17      },
18      "id": "string",
19      "name": "string",
20      "enabled": true,
21      "alert_type": "general",
22      "metadata": {},
23      "triggers": [
24        {
25          "event_type": "trace:errors",
26          "id": "string",
27          "alert_id": "string",
28          "trigger_configs": [
29            {
30              "type": "scope:project",
31              "id": "string",
32              "alert_trigger_id": "string",
33              "config_value": {},
34              "group_index": 1,
35              "created_at": "2024-01-15T09:30:00Z",
36              "created_by": "string",
37              "last_updated_at": "2024-01-15T09:30:00Z",
38              "last_updated_by": "string"
39            }
40          ],
41          "created_at": "2024-01-15T09:30:00Z",
42          "created_by": "string"
43        }
44      ],
45      "created_at": "2024-01-15T09:30:00Z",
46      "created_by": "string",
47      "last_updated_at": "2024-01-15T09:30:00Z",
48      "last_updated_by": "string",
49      "project_id": "string"
50    }
51  ],
52  "sortable_by": [
53    "string"
54  ]
55}
Find alerts
Was this page helpful?
Previous

Create alert

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
sortingstringOptional
filtersstringOptional

Response

OK
pageinteger
sizeinteger
totallong
contentlist of objects
sortable_bylist of strings