認証
利用状況の見方
API キー設定画面に表示される usage summary の意味と、そこから何を判断するかを説明します。
このページの内容7項目
API キー設定画面には、直近 30 日の利用状況が表示されます。これは API キーを作るだけで終わらせず、実際にどの連携が使われているかを確認するための画面です。
集計期間
usage summary は、その時点から遡る直近 30 日(rolling)を表示します。画面上部の period badge が現在の集計期間です。
利用がない期間は、empty state が表示されます。
サマリーカードで見えるもの
| 項目 | 意味 |
|---|---|
リクエスト数 | 期間内の総 request 数 |
利用エンドポイント | 期間内に利用した endpoint の種類数 |
レスポンス総量 | 期間内に返した response bytes の合計 |
最終リクエスト | 最後に request があった時刻 |
時刻はワークスペース上では JST で表示されます。
endpoint 別の内訳
サマリーカードの下には endpoint ごとの内訳が表示されます。
各行で見えるもの:
- endpoint 名
- その endpoint の request 数
- その endpoint の response bytes
この一覧は request 数の多い順に並びます。同率のときは endpoint 名で並びます。
API キーのテーブル
同じ画面の API キーのテーブルでは、キーごとの状態と利用状況を確認できます。
主な列:
名前プレフィックス状態最終利用直近30日 request直近30日 response bytes有効期限作成日
このテーブルを見ると、どのキーが実際に使われているか、どのキーがもう不要かを判断できます。
この画面で判断すること
- 直近 30 日で未利用のキーは revoke してよいか
- 1 本のキーに利用が集中していないか
- 期待していない endpoint が多く叩かれていないか
- rotate 後に新しいキーへ実際に切り替わったか
よくある見方
利用直後:
最終リクエストが更新されたかリクエスト数が増えたか
運用中:
- 特定キーの
直近30日 requestが急に増えていないか レスポンス総量が大きい endpoint が想定どおりか
整理するとき:
- 未利用のキーを整理する
- 期限付きキーが切れる前に rotate する
初回ユーザーが確認すべきこと
クイックスタートのコマンドを一通り実行したあとに、API キー設定画面へ戻って次を確認してください。
- request が 0 ではなくなっている
companiesやprofileなど、叩いた endpoint が breakdown に見える- 使ったキーの
最終利用が更新されている
この確認まで終えると、単にキーを発行しただけではなく、実際にプロダクトを使えたことが分かります。