Find alerts | Opik Documentation

curl http://localhost:5173/api/v1/private/alerts \
     -H "Content-Type: application/json"

{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "webhook": {
        "url": "https://hooks.example.com/alerts/error",
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "name": "Error Alert 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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "High Error Rate Alert",
      "enabled": true,
      "alert_type": "general",
      "metadata": {
        "severity": "high",
        "description": "Alert for error rate exceeding threshold"
      },
      "triggers": [
        {
          "event_type": "trace:errors",
          "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "alert_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "trigger_configs": [
            {
              "type": "threshold:errors",
              "id": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
              "alert_trigger_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
              "config_value": {
                "threshold": "100",
                "period": "5m"
              },
              "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": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    }
  ],
  "sortable_by": [
    "name",
    "created_at",
    "enabled"
  ]
}

Find alerts

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

sortingstringOptional

filtersstringOptional

Response

pageinteger

sizeinteger

totallong

contentlist of objects

sortable_bylist of strings