コンテンツにスキップ

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. 完了したら、アラートを有効化をオンに切り替えます。 1時間以内にTrack usersエンドポイントが100パーセント増加した場合に通知を送信するAPI使用量アラートの例。

アラートしきい値

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

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

  • 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のボディのサンプルペイロードです。

{
  "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
  }
}

ペイロードフィールドの詳細

フィールド タイプ 説明
text string 人間が読めるアラートメッセージ。
data.alert_name string アラートの名前。
data.alert_type string アラートのタイプ(常に"API Usage Alert")。
data.app_group_name string ワークスペース名。
data.alert_criteria.response_codes string アラートに選択されたレスポンスコード。何も選択されていない場合は"all response codes"を返し、単一のコードの場合は"201"、複数のコードの場合は"201, 202 and 203"のように返します。
data.alert_criteria.threshold_condition string 条件タイプ:"increase by"、"decrease by"、"greater than or equal"、または"less than or equal"。
data.alert_criteria.threshold_volume string または number しきい値。条件がパーセンテージを使用する場合は%で終わる文字列です(例:"50%")。条件が数値を使用する場合は数値です(例:50)。
data.alert_criteria.within string アラート評価の時間ウィンドウ(例:"1 day")。
data.timeframe_start string UTC形式YYYY-MM-DD HH:MM:SSでのアラート期間の開始。
data.timeframe_end string UTC形式YYYY-MM-DD HH:MM:SSでのアラート期間の終了。
data.volume number アラート期間中のリクエストボリューム。
data.previous_timeframe_start string (オプション)前の期間の開始。比較しきい値条件の場合にのみ存在します。
data.previous_timeframe_end string (オプション)前の期間の終了。比較しきい値条件の場合にのみ存在します。
data.previous_volume number (オプション)前の期間中のリクエストボリューム。比較しきい値条件の場合にのみ存在します。

アラートの設定例

以下のシナリオで通知を受け取るための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回のみ送信します。これは、単一のアラートから通知が過剰に送信されるのを防ぐためです。アラートが早すぎるタイミングで通知を送る場合は、ユースケースに合うようにアラート条件の編集を検討してください。
  • ワークスペースごとに最大10個のアラートを設定できます。
New Stuff!