List Alerts

GEThttps://api.confident-ai.com/v2/scheduled-alerts

Lists the scheduled alerts in your Confident AI project one page at a time, ordered by name. Each alert is returned as a summary row; retrieve one by id for its aggregation, filters, threshold, severity and run history.

GET/v2/scheduled-alerts

curl -X GET "https://api.confident-ai.com/v2/scheduled-alerts" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "scheduledAlerts": [
      {
        "id": "<SCHEDULED-ALERT-ID>",
        "name": "Trace error rate spike",
        "dataModel": "TRACE",
        "enabled": true
      }
    ],
    "totalScheduledAlerts": 7,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/monitors",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page of scheduled alerts to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of scheduled alerts per page, at most 100. Defaults to 25.
dataModelenum
Returns only alerts measuring this kind of item. Omit to return all of them.
enabledenum
Returns only alerts whose schedule is running when true, or only the paused ones when false. Omit to return both.

Response

List Alerts succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of scheduled alerts, with the total across all pages.
Show 4 propertiesHide 4 properties
- scheduledAlertslist of objects
  The scheduled alerts for the current page, ordered by name.
  Show 4 propertiesHide 4 properties
  - idstring
    The id of the scheduled alert, generated by Confident AI.
  - namestring
    The name of the alert.
  - dataModelenum
    What kind of production item an alert measures over. TRACE and SPAN alerts aggregate single requests; THREAD alerts aggregate conversations.
    Show 8 enum valuesHide 8 enum values
    TRACE
    SPAN
    LLM_SPAN
    AGENT_SPAN
    RETRIEVER_SPAN
    TOOL_SPAN
    CUSTOM_SPAN
    THREAD
  - enabledboolean
    Whether the alert's schedule is running. False when the alert has no schedule.
- totalScheduledAlertsinteger
  The total number of scheduled alerts matching the filters.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of scheduled alerts per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI