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
20
{
  "text": "Your My First API Usage Alert alert has triggered. Please note that this alert is reset every 8 hours, and only one notification will be sent per reset period. You can view your alert and usage here: <link>.",
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "app_group_name": "My Workspace",
    "alert_criteria": {
      "response_codes": "201, 202 and 203",
      "threshold_condition": "increase by",
      "threshold_volume": "50%",
      "within": "1 hour"
    },
    "timeframe_start": "2025-03-20 15:35:00",
    "timeframe_end": "2025-03-20 16:35:00",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20 14:35:00",
    "previous_timeframe_end": "2025-03-20 15:35:00",
    "previous_volume": 1000
  }
}

참고

previous_timeframe_start, previous_timeframe_end, previous_volume 필드는 선택 사항이며, 알림이 비교 임계값 조건(increase by, decrease by)을 사용하는 경우에만 나타납니다. greater than or equal 또는 less than or equal 알림에서는 이 필드가 생략됩니다.

페이로드 필드 세부 사항

알림 예시

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

• api 상태
• 엔드포인트 사용량 제한
• api 트리거 campaigns
• 파트너 통합

고려 사항

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