API 使用状況ダッシュボード
API 使用状況ダッシュボードでは、Brazeへの受信 REST API トラフィックを監視し、REST APIの使用傾向を把握したり、潜在的な問題をトラブルシューティングしたりできます。
API 使用状況ダッシュボードについて
API 使用状況ダッシュボードを表示するには、設定 > API と識別子に移動し、ダッシュボードを選択します。
デフォルトのダッシュボードには、過去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 リクエストログが開き、そのデータポイントの時間間隔と、チャートに適用されているエンドポイント、レスポンスコード、API キーのフィルターが適用されます。
リクエストログは、過去14日間の REST API トラフィックでのみ利用できます。
考慮事項
API 使用状況ダッシュボードには、Braze が受信し、2XX、4XX、または 5XX レスポンスを返したすべての REST API リクエストが含まれます。これには、データ変換の出力とクラウドデータ取り込みの同期も含まれます。SDK トラフィックとユーザー更新ステップは、このダッシュボードには含まれません。
ダッシュボードに表示されるデータには、最近のトラフィックが反映されるまでに若干の遅延が生じる場合があります。使用量が多い期間中は、ダッシュボードを 1 分あたり最大 4 回まで更新できます。ダッシュボードを再度更新する前に、数分待つ必要がある場合があります。
リクエスト本文内の API キー
API キーをリクエストヘッダーではなくリクエスト本文で送信すると、一部のリクエストが API 使用状況ダッシュボードに表示されない場合があります。その結果、ダッシュボードのデータが不完全になり、API 使用状況を正確にモニタリングすることが難しくなる可能性があります。
API 使用状況ダッシュボードで最も正確なレポートを得るには、API キーをリクエスト本文ではなくリクエストヘッダーに含めてください。