Skip to content

API 使用状況ダッシュボード

API 使用状況ダッシュボードでは、Braze への受信 REST API トラフィックを監視し、REST API の使用傾向を把握したり、潜在的な問題をトラブルシューティングしたりできます。

API 使用状況ダッシュボードについて

API 使用状況ダッシュボードを表示するには、設定 > API キーに移動し、ダッシュボードを選択します。

デフォルトのダッシュボードには、過去1日(24時間)のワークスペースへのすべての受信 REST API リクエストが表示されます。ユースケースに応じて、ダッシュボードのコントロールを調整してトラフィックのフィルターやグループ化を行ったり、ダッシュボードの時間範囲を設定したりできます。

合計130件のリクエストがあり、成功率70%、失敗率30%の API 使用状況ダッシュボード。

利用可能な指標

API 使用状況ダッシュボードには、以下の統計情報が含まれます。

ダッシュボードの使用方法

ダッシュボードに適用するフィルター(API キー、エンドポイント、応答コード、データのグループ化、日付など)。

フィルター

フィルターを選択して、ワークスペースの REST API トラフィックの表示を絞り込むフィルターを適用します。以下のフィルターが利用できます。

  • API キー
  • エンドポイント
  • 応答コード

データのグループ化

データをさまざまなデータ系列にグループ化して、使用状況のパターンを確認できます。以下のグループ化が利用できます。

  • 応答コード(デフォルト)
  • API エンドポイント
  • API キー
  • 成功と失敗のみ

日付

必要に応じて日付フィルターを調整して、表示する時間範囲を狭めたり広げたりできます。以下のオプションがあります。

  • 今日(デフォルト)
  • カスタム
  • 過去3時間
  • 過去6時間
  • 過去12時間
  • 過去24時間
  • 昨日
  • 過去7日間
  • 過去14日間
  • 過去30日間
  • 先月から今日まで

注意事項

API 使用状況ダッシュボードには、Braze が受信し、2XX4XX、または 5XX 応答を返したすべての REST API リクエストが含まれます。これにはデータ変換の出力やクラウドデータ取り込みの同期も含まれます。SDK トラフィックやユーザーの更新ステップはこのダッシュボードには含まれません。

ダッシュボードに表示されるデータは、最新のトラフィックの表示にわずかな遅延が生じる場合があります。使用量が多い期間中は、ダッシュボードを1分あたり最大4回まで更新できます。再度更新するまでに数分待つ必要がある場合があります。

関連記事

New Stuff!