Read the analytics alert settings

GET /v1/analytics/alert-settings

The Organization's alert thresholds (1.57.0), whose revision is also the ETag; revision 0, the defaults, until the first change: spend at 50, 80 and 100 percent of the cap, the forecast alert on, and a regression at 20 percent and 100 ms over at least 200 Turns (initial values).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the analytics:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/analytics/alert-settings" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/analytics/alert-settings`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/analytics/alert-settings",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Responses

Fields of the 200 answer

The shape is AlertSettings.