List Scheduled Alerts

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

Lists the scheduled alerts in your project, ordered by name, as summary rows. Retrieve an alert by id for its threshold, filters, severity, and schedule state including how many times it has run.

GET/v1/scheduled-alerts

curl -X GET "https://api.confident-ai.com/v1/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
      }
    ]
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/monitors"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

dataModelenum
Only return alerts measuring this kind of item. Omit to return all of them.
enabledboolean
Only return alerts whose schedule is enabled, or only those paused. Omit to return both.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- scheduledAlertslist of objects
  The project's scheduled alerts, ordered by name, as summary rows.
  Show 4 propertiesHide 4 properties
  - idstring
    The unique identifier of the scheduled alert.
  - namestring
    The name of the scheduled alert.
  - dataModelenum
    What kind of item the alert measures over.
    Show 3 enum valuesHide 3 enum values
    TRACE
    SPAN
    THREAD
  - enabledboolean
    Whether the alert's schedule is running. Flattened from the alert's schedule, which the summary otherwise omits; false when the alert has no schedule.
linkstring
A link to the monitors page.

Built byConfident AI