Skip to content

API使用アラート

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

API使用アラートについて

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

APIカテゴリ 詳細
REST APIエンドポイント Brazeのバックエンドに対して行われたすべてのREST API呼び出しの使用状況をトラッキングします。例えば、メッセージ送信、キャンペーン作成、ユーザーエクスポートなどです。
SDK APIリクエスト Braze SDKからクライアントアプリに対して行われるAPIリクエストを追跡します。例えば、アプリ内メッセージのトリガーやユーザーデータの同期などです。

*「月間アクティブユーザー – CY 24-25」を購入した顧客のみが利用可能です。

API使用量アラートの作成

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

  1. 設定 > APIキー > API使用量アラートに移動し、新しいアラートを作成します。
  2. アラートの名前を入力し、通知を受け取りたいREST APIエンドポイントとAPIキーを選択します。
  3. アラート基準を定義するには、1つ以上の応答コードを選択し、アラートしきい値を指定します。
  4. 完了したら、Alert enabledをオンに切り替えます。 API使用アラートの例。ユーザートラッキングエンドポイントが1時間以内に100％増加した場合に通知を送信します。

アラートしきい値

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

アラートしきい値
フィールド 説明
しきい値条件 通知を受けたいしきい値のボリュームに至るまでの条件を定義します。以下がサポートされています。

  • Increased byまたはDecreased by：リクエストを前回の時間枠と比較します。
  • Increased by percentageまたはDecreased by percentage：リクエストのパーセント変化を前回の時間枠と比較します。
  • Greater than or equalまたはless than or equal：時間枠内のリクエストをカウントします。
しきい値ボリューム しきい値条件と組み合わせて使用します。
Within (範囲内) アラート評価の時間枠です。

アラート通知の設定

メールアラート、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の全般的な健全性を監視するためのアラートを設定できます。例えば、APIエラーが前の1時間から20%など大幅に増加した場合にアラートを設定できます。

エンドポイント APIキー 応答コード しきい値条件 しきい値ボリューム 時間枠
すべてのエンドポイント すべてのAPIキー 4XX および 5XX 10%増加 10 1時間

ワークスペースが /users/track エンドポイントのレート制限に達した場合にアラートを受け取ります。この設定は他のBrazeエンドポイントにも適用できます。

エンドポイント APIキー 応答コード しきい値条件 しきい値ボリューム 時間枠
/users/track すべてのAPIキー 429 以上 100 1時間

このアラート設定は、APIトリガーのキャンペーンやキャンバスでエラーが発生した場合に通知します。これらの中には優先度の高いものも含まれる場合があります。

エンドポイント APIキー 応答コード しきい値条件 しきい値ボリューム 時間枠
  • /campaigns/trigger/send
  • /canvas/trigger/send
  • /messages/send
 すべてのAPIキー 4XX および 5XX 以上 1 1時間

パートナー連携がBrazeへのデータ送信を停止した場合にアラートを受け取るには、以下のアラート設定を使用します。

エンドポイント APIキー 応答コード しきい値条件 しきい値ボリューム 時間枠
すべてのエンドポイント パートナー連携に使用しているAPIキー すべての応答コード 以下 0 1日

注意事項

  • 各アクティブアラートは、メールまたはWebhook通知を8時間に1回のみ送信します。これは、1つのアラートから過剰な通知が送信されるのを防ぐためです。アラートが早すぎるタイミングで通知される場合は、ユースケースに合うようにアラート基準を編集することを検討してください。
  • ワークスペースごとに最大10個のアラートを設定できます。
New Stuff!