API 使用状況ダッシュボード
API 使用状況ダッシュボードでは、Brazeへの受信 REST API トラフィックを監視し、REST APIの使用傾向を把握したり、潜在的な問題をトラブルシューティングしたりできます。
API 使用状況ダッシュボードについて
API 使用状況ダッシュボードを表示するには、設定 > API とIdentifiers に移動し、ダッシュボードを選択します。
デフォルトのダッシュボードには、ワークスペースに対する過去1日（24時間）のすべての受信 REST API リクエストが表示されます。ユースケースに応じて、ダッシュボードのコントロールを調整してトラフィックのフィルタリングやグループ化を行ったり、ダッシュボードの時間範囲を設定したりできます。
利用可能な指標
API使用状況ダッシュボードには以下の統計情報が含まれています。
| 指標 | 説明 |
|---|---|
| リクエスト合計 | ダッシュボードに適用されたフィルターとコントロールに基づいた、現在のワークスペースでBrazeに送信されたリクエストの合計数です。 |
| 成功率 | Brazeが 2XX 成功レスポンスを返したリクエストの割合です。 |
| エラー率 | Brazeが 4XX または 5XX エラーレスポンスを返したリクエストの割合です。 |
ダッシュボードの使用
フィルター
フィルターを選択して、ワークスペースのREST APIトラフィックの表示を絞り込むフィルターを適用します。以下が含まれます。
- API キー
- エンドポイント
- レスポンスコード
データのグループ化
データをさまざまなデータシリーズにグループ化して、使用状況のさまざまなパターンを調べることができます。以下が含まれます。
- レスポンスコード（デフォルト）
- API エンドポイント
- API キー
- 成功と失敗のみ
日付
必要に応じて日付フィルターを調整し、表示する時間範囲を狭めたり広げたりできます。以下が含まれます。
- 今日（デフォルト）
- カスタム
- 過去3時間
- 過去6時間
- 過去12時間
- 過去24時間
- 昨日
- 過去7日間
- 過去14日間
- 過去30日間
- 先月から今日まで
過去3時間と過去6時間のオプションでは、分単位でトラフィックが表示されます。より長い期間では、5分ごと、1時間ごと、または1日ごとにトラフィックが表示されます。
注意事項
API 使用状況ダッシュボードには、Braze が受信し、2XX、4XX、または 5XX レスポンスを返したすべての REST API リクエストが含まれます。これには、データ変換の出力やCloud Data Ingestion の同期も含まれます。SDK トラフィックおよび User Update ステップは、このダッシュボードには含まれません。
ダッシュボードに表示されるデータには、最新のトラフィックが反映されるまでわずかな遅延が生じる場合があります。使用量が多い期間中は、ダッシュボードを1分間に最大4回まで更新できます。再度ダッシュボードを更新するには、数分待つ必要がある場合があります。
リクエストボディ内のAPIキー
API キーがリクエストヘッダーではなくリクエストボディで送信された場合、一部のリクエストが API 使用状況ダッシュボードに表示されないことがあります。これにより、ダッシュボードのデータが不完全になり、API の使用状況を正確に監視することが難しくなる可能性があります。
API 使用状況ダッシュボードで最も正確なレポートを得るには、API キーをリクエストボディではなくリクエストヘッダーに含めてください。