Skip to main content
PUT
/
v1
/
config
/
index-rate
Update Index Rate Alert
curl --request PUT \
  --url https://api.mezmo.com/v1/config/index-rate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "max_lines": 123,
  "max_z_score": 123,
  "channels": {
    "email": [
      "<string>"
    ],
    "pagerduty": [
      "<string>"
    ],
    "slack": [
      "<string>"
    ],
    "webhook": [
      {
        "url": "<string>",
        "headers": {
          "timestamp": "<string>"
        },
        "bodyTemplate": "<string>"
      }
    ]
  },
  "enabled": true
}
'
{
  "max_lines": 123,
  "max_z_score": 123,
  "channels": {
    "email": [
      "<string>"
    ],
    "pagerduty": [
      "<string>"
    ],
    "slack": [
      "<string>"
    ],
    "webhook": [
      {
        "url": "<string>",
        "headers": {
          "timestamp": "<string>"
        },
        "bodyTemplate": "<string>"
      }
    ]
  },
  "enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://mezmo-9a59581a-mintlify-926f893d.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

This key is used for all apis with the exception of ingest. You can obtain it following these instructions and placing the key in the header of your call in the format of Authorization: Token {accesstoken} For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

Body

application/json

Request parameters

​
max_lines
integer

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

​
max_z_score
integer

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

​
threshold_alert
enum<string>

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.

Available options:
separate,
both
​
frequency
enum<string>

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.

Available options:
hourly,
daily
​
channels
object
​
enabled
boolean

Response

OK

​
max_lines
integer

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

​
max_z_score
integer

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

​
threshold_alert
enum<string>

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.

Available options:
separate,
both
​
frequency
enum<string>

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.

Available options:
hourly,
daily
​
channels
object
​
enabled
boolean