API 사용 알림

API 사용 알림은 API 사용 현황에 대한 중요한 가시성을 제공하여 예상치 못한 트래픽을 사전에 탐지할 수 있게 합니다. 이러한 알림을 설정하여 주요 API 요청량을 추적하면 실시간으로 알림을 받고, 문제가 마케팅 캠페인에 영향을 미치기 전에 해결할 수 있습니다.

API 사용 알림에 관하여

API 사용량 알림을 사용하여 다음 범주의 요청량을 모니터링할 수 있습니다:

API 사용량 알림 생성

API 사용량 알림을 생성하려면:

1. 설정 > API 및 식별자 > API 사용량 알림으로 이동한 후 새 알림을 생성하세요.
2. 알림에 대한 이름을 입력하고 알림을 받고 싶은 REST API 엔드포인트 및 API 키를 선택하세요.
3. 하나 이상의 응답 코드를 선택하고 경보 임계값을 지정하여 경보 기준을 정의하세요.
4. 완료되면 알림 활성화를 토글하세요.

경보 임계값

경보 기준을 정의할 때 다음 임계값을 조정할 수 있습니다:

알림 설정

이메일 알림, 웹훅 알림 또는 둘 다 설정할 수 있습니다. 웹훅 알림은 Slack 채널과 같은 외부 플랫폼으로 알림을 보내는 사용 사례에 매우 유용합니다. 예시는 알림 환경설정에 대한 Slack 연동에 관한 설명서를 참조하세요.

샘플 페이로드

다음은 API 사용량 알림 웹훅 본문의 샘플 페이로드입니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "alert_criteria": {
    	"response_codes": ["201", "202", "203"],
    	"threshold_condition": "Increased by %",
    	"threshold_volume": 50,
    	"within": "1 day"
    },
    "timeframe_start": "2025-03-20T15:35:00Z",
    "timeframe_end": "2025-03-20T16:35:00Z",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20T14:35:00Z",
    "previous_timeframe_end": "2025-03-20T15:35:00Z",
    "previous_volume": 1000
  },
  "text": "Your My First API Usage Alert alert has triggered. You can view your alert and usage here: <link>. Note that this alert will reset in 1 day, as each alert will only send one notification per 8 hours."
}

알림 예시

다음은 아래 시나리오에서 알림을 받을 수 있도록 API 사용량 알림 구성을 설정하는 몇 가지 방법입니다.

• api health
• endpoint rate limit
• api-triggered campaigns
• partner integrations

고려 사항

• 각 활성 알림은 8시간마다 한 번만 이메일 또는 웹훅 알림을 전송합니다. 이는 단일 알림에서 너무 많은 알림이 발생하는 것을 방지하기 위함입니다. 알림이 너무 일찍 발송되는 경우, 사용 사례에 더 적합하도록 알림 기준을 편집하는 것을 고려하세요.
• 워크스페이스당 최대 10개의 알림을 설정할 수 있습니다.