Skip to main content
GET
/
v1
/
alert-rules
List alert rules
curl --request GET \
  --url https://api.poly.ai/v1/alert-rules \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "metric": "turn_latency_p50",
      "operator": ">",
      "threshold_value": 1,
      "window_duration_seconds": 2,
      "enabled": true,
      "current_state": "ok",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_id": "<string>",
      "since": "2023-11-07T05:31:56Z",
      "last_evaluated_at": "2023-11-07T05:31:56Z",
      "current_value": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
enabled
boolean
​
metric
enum<string>
Available options:
turn_latency_p50,
turn_latency_p95,
api_errors,
function_errors,
call_crashes,
call_volume
​
project_id
string
​
state
enum<string>
Available options:
ok,
alert,
no_data,
unknown

Response

Alert rules retrieved successfully.

​
data
object[]
required