Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
Claude Code / Codex で始めるドキュメントマップsf CLI をインストールデータ・API・CLIの現況クイックスタートCLI 接続設定会社IDの見方初日の進め方Data Provenance
認証請求認証設定利用プランCLI
CLI 概要CLI 認証基本コマンド会社検索観測データ検索会社・観測・開示開示の表示・比較リスト・調査・クレジットヘルプとエラーコマンドとフラグCLI 更新
APIキーのライフサイクル利用量の計測提供中の機能
会社検索とプロフィール観測データ検索チームワークスペース会社の観測データ開示と比較APIキー管理UIリストワークスペース外部調査とクレジットSkills / CLI / API
Credit Schedule利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラートラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意credit と maxCredits の失敗estimate と materialize の失敗
認証

Usage Summary

API キー設定画面に表示される usage summary の意味と、そこから何を判断するかを説明します。

このページの内容7項目
集計期間サマリーカードで見えるものendpoint breakdownAPI キー tableこの画面で判断することよくある見方初回ユーザーが確認すべきこと

API キー設定画面には、直近 30 日の利用状況が表示されます。これは API キーを作るだけで終わらせず、実際にどの連携が使われているかを確認するための画面です。

集計期間

usage summary は rolling な直近 30 日を表示します。画面上部の period badge が現在の集計期間です。

利用がない期間は、empty state が表示されます。

サマリーカードで見えるもの

項目意味
リクエスト数期間内の総 request 数
利用エンドポイント期間内に利用した endpoint の種類数
レスポンス総量期間内に返した response bytes の合計
最終リクエスト最後に request があった時刻

時刻表示は workspace 上で JST として見られます。

endpoint breakdown

summary card の下には endpoint ごとの内訳が表示されます。

各行で見えるもの:

  • endpoint 名
  • その endpoint の request 数
  • その endpoint の response bytes

この一覧は request 数の多い順に並びます。同率のときは endpoint 名で並びます。

API キー table

同じ画面の API キー table では、キーごとの状態と利用状況を確認できます。

主な列:

  • 名前
  • プレフィックス
  • 状態
  • 最終利用
  • 直近30日 request
  • 直近30日 response bytes
  • 有効期限
  • 作成日

この table を見ると、どのキーが実際に使われているか、どのキーがもう不要かを判断できます。

この画面で判断すること

  • 直近 30 日で未利用のキーは revoke してよいか
  • 1 本のキーに利用が集中していないか
  • 期待していない endpoint が多く叩かれていないか
  • rotate 後に新しいキーへ実際に切り替わったか

よくある見方

利用直後:

  • 最終リクエスト が更新されたか
  • リクエスト数 が増えたか

運用中:

  • 特定 key の 直近30日 request が急に増えていないか
  • レスポンス総量 が大きい endpoint が想定どおりか

整理するとき:

  • 未利用 のキーを整理する
  • 期限付きキーが切れる前に rotate する

初回ユーザーが確認すべきこと

Quick Start のコマンドを一通り実行したあとに、API キー設定画面へ戻って次を確認してください。

  • request が 0 ではなくなっている
  • companies や profile など、叩いた endpoint が breakdown に見える
  • 使ったキーの 最終利用 が更新されている

この確認まで終えると、単にキーを発行しただけではなく、実際に product を使えたことが分かります。

このページの内容

集計期間サマリーカードで見えるものendpoint breakdownAPI キー tableこの画面で判断することよくある見方初回ユーザーが確認すべきこと