List active alerts | Alephant API Documentation

curl -G https:https://localhost:8080/api/v1/alerts/active \
     -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken1234567890" \
     -H "X-Workspace-Id: a3f1c9d2-4b7e-4f8a-9c3d-2e5f7a1b9c0d" \
     -H "Content-Type: application/json" \
     -d severity=high \
     -d type=budget_threshold \
     -d status=active \
     -d departmentId=d2f4e6a8-9b7c-4d3e-8f1a-0b2c3d4e5f6a \
     -d page=1 \
     -d pageSize=20

{
  "data": [
    {
      "id": "b7a1c2d3-e4f5-6789-abcd-ef0123456789",
      "workspaceId": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7a1b9c0d",
      "departmentId": "d2f4e6a8-9b7c-4d3e-8f1a-0b2c3d4e5f6a",
      "type": "budget_threshold",
      "severity": "high",
      "status": "active",
      "message": "Monthly budget exceeded by 15%",
      "createdAt": "2024-06-10T09:15:00Z",
      "updatedAt": "2024-06-10T09:45:00Z"
    },
    {
      "id": "c8d9e0f1-a2b3-4c5d-6e7f-890123456789",
      "workspaceId": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7a1b9c0d",
      "departmentId": "d2f4e6a8-9b7c-4d3e-8f1a-0b2c3d4e5f6a",
      "type": "usage_anomaly",
      "severity": "medium",
      "status": "active",
      "message": "Unexpected spike in API calls detected",
      "createdAt": "2024-06-09T16:30:00Z",
      "updatedAt": "2024-06-10T08:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "totalPages": 3,
    "totalItems": 45
  }
}

Offset-paginated active alerts. Team+ tier. Default status=active.

Query parameters

severitystringOptional

Filter: high, medium, low

typestringOptional

Filter: budget_threshold, usage_anomaly, etc.

statusstringOptional

Filter: active, acknowledged (default active)

departmentIdstringOptional

Enterprise: filter by department UUID

pageintegerOptional

Page (default 1)

pageSizeintegerOptional

Page size (default 20, max 100)

Response

data: ActiveAlertItem[], meta: AlertsListMeta

Errors

403

Forbidden Error

Headers

Query parameters

Response

Errors