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

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

API利用ダッシュボードについて

API使用状況のダッシュボードを表示するには、設定>APIと識別子と進み、ダッシュボードを選択する。

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

!API Usageダッシュボードには130のリクエストがあり、成功率は70％、失敗率は30％であった。

使用可能なメトリック

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

指標	説明
リクエスト数の合計	ダッシュボードに適用されているフィルターとコントロールを指定して、現在のワークスペースに対して Braze に送信されたリクエストの合計数。
成功率	Braze が 2XX 成功応答を発行したリクエストの合計の割合。
エラー率	Braze が 4XX または 5XX エラー応答を発行したリクエストの合計の割合。

ダッシュボードを使う

!ダッシュボードに適用するフィルターである：APIキー、エンドポイント、レスポンシブコード、グループデータ、日付。

フィルター

Filters を選択して、以下を含むワークスペースのREST API トラフィックのビューを絞り込むフィルタを適用します。

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

グループデータ

データをさまざまなデータ系列にグループ化して、次のような使用方法のさまざまなパターンを調べることができます。

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

日付

必要に応じて、日付フィルターを調整して、表示する時間範囲を増減します。これには以下が含まれます:

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

考慮事項

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

ダッシュボードに表示されるデータでは、最近のトラフィックを表示するのに最大で短い遅延が発生する場合があります。使用率が高い時間帯には、1分間に最大4回ダッシュボードを更新できます。数分待ってから、ダッシュボードを再度更新する必要がある場合があります。