ダッシュボードの概要
FourA Dashboardでは、API keyの管理、テストrequestの実行、パフォーマンスの監視、請求の処理、アカウントの設定を行います。このページでは、メインのOverview画面とサイドバーのセクションについて説明します。
Accessing the Dashboard
foura.ai/dashboardからサインインします。FourAアカウントが必要です。まだお持ちでない場合は、こちらからサインアップしてください。
Overview Page
サインイン後のランディングページには、アカウントのリアルタイムの統計情報が表示されます。
Summary Cards
上部の5つのパネルには、選択した期間の主要な数値が表示されます。
| Panel | What it shows |
|---|---|
| Concurrency | 現在のアクティブな同時request数、および期間内の平均と最大値 |
| Requests | 選択した期間内の合計request数 |
| Credits | requestが消費したCredit数(Total、Single、Proxy、Browserの内訳) |
| Bytes | 転送されたデータ量(送受信) |
| Response Time | request全体の平均、最小、最大の応答時間 |
Timeline Charts
パネルの下には、request数、Credit消費、結果の内訳、応答時間、帯域幅、同時実行数を示す6つのタイムライングラフがあり、傾向を一目で確認できます。各グラフのヘッダーにあるトグルで、グラフと基になる表を切り替えることができます。
Filters
カードの上に4つのコントロールがあります。これらは重ねて組み合わせることができます。プロダクトを選択し、1つの結果カテゴリに絞り込んでから、単一のAPI keyまたは期間に絞り込みます。
| Filter | What it does |
|---|---|
| Product | カードとグラフのスコープをSingle、Proxy、Browserのいずれかのendpointに設定します。Autoのサブコールは、該当するサブコールプロダクトの下に表示されます(Auto自体は個別の請求項目ではありません)。 |
| Outcome | 1つの結果カテゴリ(Success、Client Error、Service Error、Service Fail、Rate Limited、App Error、App Fail)を抽出します |
| Key | 特定のAPI keyに制限します |
| Interval | タイムウィンドウ: 1M、5M、30M、1H、6H、または1D |
ConcurrencyのカードとグラフはProductまたはOutcomeフィルターの影響を受けず、いずれかが有効な間は「Not filterable」バッジが表示されます。
Sidebar Sections
サイドバーには、Dashboard、My Keys、Accountにグループ化された9つのセクションへのリンクがあります。
Overview
上記のページです。サインイン後の開始点となります。
Playground
コードを記述せずに、実際のAPI keyに対してライブrequestをテストします。Auto、Single、Proxy、Browserのいずれかを選択し、URLを設定し、フラグとタイムアウトを調整して、Sendをクリックします。一般的な構成をプリセットとして保存し、Historyから過去20回の実行を再実行できます。
本番環境の呼び出しと同様に、使用量はkeyのクォータにカウントされます。詳細な手順については、Playground guideを参照してください。
Metrics
結果分布のドーナツグラフと、API key、クライアントIP、またはドメインでグループ化されたマルチビューの使用状況表です。
Activity
最近のAPI requestのライブフィードです。各エントリには、HTTPメソッド、ルート、ターゲットドメイン、ステータスコード、結果の分類、期間、転送サイズが表示されます。個々のrequestのデバッグや、統合が機能していることの確認に使用します。
API Keys
アプリケーションがAPIを呼び出すために使用するキーの作成、表示、管理を行います。
- 新しいキーの作成: アプリケーション用のキーを生成します。
- 既存のキーの表示: すべてのキーと、そのステータス、IP許可リスト、有効期限、最終使用時間を表示します。
- キーの無効化: キーを削除せずに無効にします(ローテーションに便利です)。
- 再生成: 設定を変更せずにキーのシークレットを置き換えます。
キーにはpk_live_プレフィックスが使用され、作成時にのみ全体が表示されます。それ以降はプレフィックスのみが表示されます。
組織
1人の所有者の下でコラボレーターとキーを共有します。組織所有のキーでの使用量は、組織所有者のプランにカウントされます。組織を参照してください。
使用量と制限
プラン、今請求期間中の使用量、測定されるすべての制限について、キー別およびプロダクト別の内訳を表示します。使用量と制限を参照してください。
請求
サブスクリプション、支払い方法、請求書を管理します。請求セクションには、現在のプランの使用状況(消費されたクレジットとプランの制限)もプログレスバーで表示されます。
設定
プロフィールとセキュリティ設定を更新します。
- 表示名と会社名
- パスワード
- デバイス全体のアクティブなセッション
- 接続されたOAuthプロバイダー(Googleなど)
メールアドレスの変更はダッシュボードでは利用できません。メールアドレスを更新する必要がある場合はサポートにお問い合わせください。
ヒント
- コードを記述する前にPlaygroundを使用してください。新しいサイトに必要なエンジンがわからない場合は、Autoから始めて選択させてください。
- Metricsを毎週確認し、問題になる前にパフォーマンスの傾向を把握してください。
- APIキーを安全に保ちます。公開された疑いがある場合は、直ちにキーを無効にしてください。
- 必要なBillingまたはSettingsの詳細が表示されない場合は、以下のリンク先のページで完全なウォークスルーを確認してください。
次のステップ
- 認証: APIキーの作成と管理の詳細
- クイックスタート: CLI経由で最初のリクエストを実行する
- Playground: ダッシュボードからライブリクエストを実行する
- 使用量と制限: プランに対してクレジットを追跡する
- APIエンドポイント: APIを直接使用する