Sign in

v1

latestOpenAPI 3.1.02026-07-26189891.1 MB
Index Rate Alert

Update Index Rate Alert

Use this method to update an index rate alert. You can change the alert's configuration details.

put/v1/config/index-rate

Request body

max_linesinteger

The number of lines required in order to trigger the alert.

max_z_scoreinteger

The number of standard deviations above the 30 day average lines in order to trigger the alert.

threshold_alert'separate' | 'both'

Determines if you want alerts to be triggered if both the max lines and standard deviation have been triggered, or if one of the thresholds has been reached.

frequency'hourly' | 'daily'

Notify recipients once per hour, or once per day, (starting when the threshold is passed the first time) until the index rate drops below the thresholds. When the index rate drops below the thresholds, alerting stops.

enabledboolean

Response

OK

max_linesinteger

The number of lines required in order to trigger the alert.

max_z_scoreinteger

The number of standard deviations above the 30 day average lines in order to trigger the alert.

threshold_alert'separate' | 'both'

Determines if you want alerts to be triggered if both the max lines and standard deviation have been triggered, or if one of the thresholds has been reached.

frequency'hourly' | 'daily'

Notify recipients once per hour, or once per day, (starting when the threshold is passed the first time) until the index rate drops below the thresholds. When the index rate drops below the thresholds, alerting stops.

enabledboolean