Create Scheduled Alert

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

Creates an alert that re-runs an aggregate query on a schedule and notifies when the result crosses the threshold.

Notifications are delivered through the project's integrations that have alerting enabled for the alert's severity, so an alert in a project with no such integration still evaluates but reaches nobody.

Retrieve the alert by id to read back the stored definition, including the schedule the server derived.

POST/v1/scheduled-alerts

curl -X POST "https://api.confident-ai.com/v1/scheduled-alerts" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Trace error rate spike",
  "description": "Errors above 5% over the last hour",
  "dataModel": "TRACE",
  "aggregation": "ERROR_RATE",
  "thresholdSettings": {
    "value": 0.05,
    "direction": "above"
  },
  "severity": "ERROR",
  "recurrence": "INTERVAL",
  "repeatEvery": 1,
  "repeatUnit": "HOUR"
}'

200

{
  "success": true,
  "data": {
    "id": "SCHEDULED-ALERT-ID"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/monitors"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

descriptionstring
What the alert means and what to do about it. Included in the notification.
filtersobject
A set of filter groups combined by a top-level operator.
Show 2 propertiesHide 2 properties
- operatorenumRequired
  How filters or groups are combined.
  Show 2 enum valuesHide 2 enum values
  - AND
  - OR
- groupslist of objectsRequired
  The filter groups.
  Show 2 propertiesHide 2 properties
  - operatorenumRequired
    How filters or groups are combined.
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - filterslist of objectsRequired
    The filter rows in this group.
    Show 4 propertiesHide 4 properties
    categorystringRequired
    The property a filter row matches on (e.g. "Name", "User Id", "Model", "Metadata"). The set of valid values depends on the line's dataModel.
    conditionenumRequired
    The comparison a filter row applies. Valid conditions depend on the category.
    Show 18 enum valuesHide 18 enum values
    Is
    Is not
    Is equal to
    Does not equal
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Has
    Has not
    Contains
    Contains only
    Does not contain
    Has increased by more than
    Has increased by less than
    Has decreased by more than
    Has decreased by less than
    Has changed from
    valuestring | number | list of stringsRequired
    The value to match against.
    Show 3 variantsHide 3 variants
    string
    OR
    number
    OR
    list of strings
    keystring
    The property key. Auto-populated from category when omitted; required for Metadata, Metric, and Classifier filters.
severityenum
How urgent the alert is. Also decides which of the project's integrations receive it. Defaults to WARNING.
Show 4 enum valuesHide 4 enum values
- CRITICAL
- ERROR
- WARNING
- INFO
recurrenceenum
Whether the alert runs repeatedly or a single time. Defaults to INTERVAL.
Show 2 enum valuesHide 2 enum values
- ONCE
- INTERVAL
repeatEveryinteger
How many repeatUnits between runs. Required for INTERVAL.
repeatUnitenum
The unit paired with repeatEvery. Together they also set the measurement window, so an alert repeating every hour compares the last hour of data. A ONCE alert measures the last 24 hours.
Show 5 enum valuesHide 5 enum values
- MINUTE
- HOUR
- DAY
- WEEK
- MONTH
startAtstring
When the schedule starts running. Starts immediately when omitted.
maxRunsinteger
Stop the alert after it has triggered this many times.
endAtstring
When the schedule stops running.
enabledboolean
Whether the schedule runs. Defaults to true on create. An alert whose run limit or end date has passed cannot be re-enabled.
namestringRequired
A name for the alert, shown in the notification.
dataModelenumRequired
What kind of item the alert measures over.
Show 3 enum valuesHide 3 enum values
- TRACE
- SPAN
- THREAD
aggregationstringRequired
What to measure. Which values are valid depends on dataModel: TRACE accepts COUNT, ERROR_RATE, PASS_RATE, UNIQUE_END_USERS, UNIQUE_THREADS, AVG_LATENCY, P50_LATENCY, P90_LATENCY, P99_LATENCY; SPAN accepts COUNT, AVG_LATENCY, P50_LATENCY, P90_LATENCY, P99_LATENCY, INPUT_COST, OUTPUT_COST, TOTAL_COST, AVG_COST, INPUT_TOKENS, OUTPUT_TOKENS, TOTAL_TOKENS; THREAD accepts COUNT and UNIQUE_USERS. Note SPAN has no error rate and TRACE has no cost aggregation.
thresholdSettingsobjectRequired
When the alert fires. Latency is compared in seconds, cost in USD, and rates such as ERROR_RATE as fractions between 0 and 1.
Show 2 propertiesHide 2 properties
- valuenumberRequired
  The number the measured value is compared against.
- directionenumRequired
  Whether the alert fires when the measured value rises above the threshold or falls below it.
  Show 2 enum valuesHide 2 enum values
  - above
  - below

Response

successboolean
Indicates if the scheduled alert was successfully created.
dataobject
Show 1 propertyHide 1 property
- idstring
  The unique identifier of the created scheduled alert.
linkstring
A link to the monitors page.

Built byConfident AI