Get Index Rate Alert

GET

config

index-rate

curl --request GET \
  --url https://api.mezmo.com/v1/config/index-rate \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.mezmo.com/v1/config/index-rate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v1/config/index-rate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v1/config/index-rate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v1/config/index-rate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "max_lines": 123,
  "max_z_score": 123,
  "channels": {
    "email": [
      "<string>"
    ],
    "pagerduty": [
      "<string>"
    ],
    "slack": [
      "<string>"
    ],
    "webhook": [
      {
        "url": "<string>",
        "headers": {
          "timestamp": "<string>"
        },
        "bodyTemplate": "<string>"
      }
    ]
  },
  "enabled": true
}

This response has no body data.

{
  "code": "<string>",
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

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

This key is used for all APIs with the exception of ingest.

Response

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

Show child attributes

enabled

boolean

⌘I

Get Index Rate Alert

curl --request GET \
  --url https://api.mezmo.com/v1/config/index-rate \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.mezmo.com/v1/config/index-rate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v1/config/index-rate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v1/config/index-rate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v1/config/index-rate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "max_lines": 123,
  "max_z_score": 123,
  "channels": {
    "email": [
      "<string>"
    ],
    "pagerduty": [
      "<string>"
    ],
    "slack": [
      "<string>"
    ],
    "webhook": [
      {
        "url": "<string>",
        "headers": {
          "timestamp": "<string>"
        },
        "bodyTemplate": "<string>"
      }
    ]
  },
  "enabled": true
}

This response has no body data.

{
  "code": "<string>",
  "error": "<string>"
}