API利用アラート

API使用アラートは、API使用状況の重要な可視性を提供し、予期せぬトラフィックをプロアクティブに検出することを可能にする。これらのアラートを設定してキーAPIリクエスト量を追跡することで、リアルタイム通知を受け取り、マーケティングキャンペーンに影響が出る前に問題に対処することができる。

API利用アラートについて

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

API使用アラートを作成する

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

1. 設定＞APIと識別子＞API使用アラートと進み、新しいアラートを作成する。
2. アラートの名前を入力し、アラートさせたいREST APIエンドポイントとAPIキーを選択する。
3. 1つまたは複数のレスポンスコードを選択し、アラートしきい値を指定することで、アラート基準を定義する。
4. 終了したら、イネーブルメントをオンに切り替える。 !Track usersエンドポイントが1時間以内に100%増加した場合に通知を送信するAPI使用アラートの例。

警告のしきい値

アラート基準を定義する際、以下の閾値を調整することができる：

アラート通知の設定

メールアラート、Webhook アラート、またはその両方を設定できます。Webhookアラートは、Slackチャネルなどの外部プラットフォームにアラートを送信するようなユースケースで非常に役立つ。例として、Slackとのアラート統合に関するドキュメントで、通知設定を参照できる。

!アラートの基準に達すると、選択したEメールにメールが送信される。

サンプルペイロード

以下は、API Usage Alert 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時間に一度だけメールまたはWebhook通知を送信する。これは、1つのアラートからの通知が多すぎるのを防ぐためである。アラートの通知が早すぎる場合は、ユースケースに合うようにアラート基準を編集することを検討する。
• ワークスペースごとに最大10個のアラートを設定できる。