API使用アラート

API使用状況アラートは、APIの使用状況を可視化する重要な手段であり、予期せぬトラフィックを事前に検知することを可能にする。これらのアラートを設定して主要なAPIリクエスト量をトラッキングすれば、リアルタイムで通知を受け取ることができ、問題がマーケティングキャンペーンに影響を与える前に解決できる。

API使用に関する警告について

API使用量アラートを使って、以下のカテゴリのリクエスト量を監視できる：

API使用量アラートの作成

API使用量アラートを作成するには：

1. 設定＞APIと識別子＞API使用量アラートに移動し、新しいアラートを作成する。
2. アラートの名前を入力し、通知を受け取りたいREST APIエンドポイントとAPI キーを選択する。
3. アラート基準を定義するには、一つ以上の応答コードを選択し、アラート閾値を指定する。
4. 終わったら、アラートをイネーブルメントする。

警報閾値

アラート基準を定義する際には、以下のしきい値を調整できる：

アラート通知の設定

メールアラート、Webhook アラート、またはその両方を設定できます。Webhookアラートは、Slackチャネルなどの外部プラットフォームへアラートを送信するといったユースケースにおいて非常に有用である。例えば、通知設定に関するアラートとSlackの連携方法については、当社のドキュメントを参照のこと。

サンプルペイロード

以下は、API使用アラートWebhookの本文に対するサンプルペイロードである。

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時間に1回だけメールまたはWebhook通知を送信する。これは単一のアラートから通知が過剰に発生するのを防ぐためだ。アラートが早すぎる場合は、ユースケースに合わせてアラートの条件を編集することを検討せよ。
• 各ワークスペースにつき最大10個のアラートを設定できる。