Find alerts by project | Opik Documentation

import requests
url = "http://localhost:5173/api/v1/private/projects/projectId/alerts"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "webhook": {
        "url": "https://hooks.example.com/alerts/error",
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Error Notifications Webhook",
        "secret_token": "s3cr3tT0k3n123",
        "headers": {
          "Authorization": "Bearer abcdef123456"
        },
        "created_at": "2024-01-15T09:30:00Z",
        "created_by": "admin_user",
        "last_updated_at": "2024-01-15T09:30:00Z",
        "last_updated_by": "admin_user"
      },
      "id": "d4f5a8e2-3c9b-4f7a-9a2e-1b2c3d4e5f6a",
      "name": "High Error Rate Alert",
      "enabled": true,
      "alert_type": "general",
      "metadata": {
        "severity": "high",
        "description": "Triggered when error rate exceeds threshold"
      },
      "triggers": [
        {
          "event_type": "trace:errors",
          "id": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
          "alert_id": "d4f5a8e2-3c9b-4f7a-9a2e-1b2c3d4e5f6a",
          "trigger_configs": [
            {
              "type": "scope:project",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "alert_trigger_id": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
              "config_value": {
                "project_id": "7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f"
              },
              "created_at": "2024-01-15T09:30:00Z",
              "created_by": "admin_user",
              "last_updated_at": "2024-01-15T09:30:00Z",
              "last_updated_by": "admin_user"
            }
          ],
          "created_at": "2024-01-15T09:30:00Z",
          "created_by": "admin_user"
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "admin_user",
      "last_updated_at": "2024-01-15T09:30:00Z",
      "last_updated_by": "admin_user",
      "project_id": "7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f"
    }
  ],
  "sortable_by": [
    "name",
    "created_at",
    "enabled"
  ]
}

Find alerts scoped to a project

Path parameters

projectIdstringRequiredformat: "uuid"

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

sortingstringOptional

filtersstringOptional

Response

Alerts page

pageinteger

sizeinteger

totallong

contentlist of objects

sortable_bylist of strings

Errors

400

Bad Request Error