Skip to main content
GET
/
alert-rules
알림 규칙 목록 조회
curl --request GET \
  --url https://client-api.tryvox.co/v3/alert-rules \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "metric_type": "call_count",
      "labels": {},
      "threshold_type": "absolute",
      "comparison_op": "gt",
      "threshold_value": 123,
      "time_window": "1m",
      "evaluation_frequency": "1m",
      "enabled": true,
      "status": "active",
      "notification_channels": [
        {
          "type": "webhook"
        }
      ],
      "paused": true,
      "created_at": 123,
      "updated_at": 123,
      "description": "<string>",
      "active_schedule": {
        "enabled": true,
        "timezone": "<string>",
        "windows": [
          {
            "days": [
              "Monday"
            ],
            "start_time": "<string>",
            "end_time": "<string>"
          }
        ]
      },
      "paused_until": 123,
      "last_notified_at": 123
    }
  ],
  "total_count": 123,
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt

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

Authorizations

Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Query Parameters

cursor
string | null

이전 응답의 next_cursor 값입니다. 다음 페이지를 조회할 때 그대로 전달합니다.

limit
integer
default:50

반환할 최대 항목 수입니다. v3 목록 endpoint는 1~100을 허용합니다.

Required range: 1 <= x <= 100
sort_by
enum<string>
default:created_at

정렬 기준 필드입니다. 기본값은 created_at입니다.

Available options:
created_at,
updated_at,
name
sort_order
enum<string>
default:desc

정렬 방향입니다. 허용값은 asc, desc입니다.

Available options:
asc,
desc

Response

성공 응답

알림 규칙 목록 페이지 응답입니다.

items
AlertRuleResponse · object[]
required

페이지 항목입니다.

total_count
integer
required

조건에 맞는 전체 항목 수입니다.

next_cursor
string | null

다음 페이지 커서입니다. 조회할 항목이 더 없으면 null입니다.