organization での API 分析情報の表示

organization 全体または特定のアプリとユーザーについての REST API アクティビティを確認できます。

この機能を使用できるユーザーについて

Organization owners and users with the "View organization API insights" permission.

Your organization must be on a GitHub Enterprise Cloud plan.

この記事の内容

Note

この機能は現在 パブリック プレビュー にあり、変更される可能性があります。 こちらの GitHub Community のディスカッションでご意見をお寄せください。

API 分析情報について

GitHub Enterprise Cloud organization 所有者と、指定されたユーザーは、organization 全体または特定のアプリとユーザーの REST API アクティビティを見ることができます。 これは、REST API アクティビティの元になっているものを理解してプライマリ レート制限を管理するのに役立ち、関連する期間、アプリ、API エンドポイントを把握できます。 プライマリ レート制限の詳細については、「REST API のレート制限」を参照してください。

Note

現在、この機能でサポートされているのは、core カテゴリの REST API エンドポイントと、プライマリ レート制限のみです。 検索、GitHub Actions (GITHUB_TOKEN シークレットを使用)、セカンダリ レート制限に関する API アクティビティはサポートされていません。 API のカテゴリについては、「レート制限用 REST API エンドポイント」を参照してください。 プライマリとセカンダリのレート制限の詳細については、「REST API のレート制限」を参照してください。

API 分析情報へのアクセスを有効にする

organization 所有者は、ユーザーが organization の API 分析情報を表示できるように、organization のカスタム役割を作成できます。 ユーザーにアクセス権を与えるには、organization のカスタム役割を作成するときに organization の API 分析情報を表示するアクセス許可を選びます。 次に、organization のメンバーまたはチームにカスタム役割を割り当てます。 詳しくは、「カスタム組織の役割の情報」をご覧ください。

Warning

organization の所有者以外にアクセスを許可すると、organization 内のすべてのユーザーとアプリの API 分析情報を表示できるようになるため、プライバシーを考慮する必要があります。

API 分析情報の集計について

期間選択機能を使うと、次の表で詳しく説明するように、定義済みの期間またはカスタム期間の API 分析情報を表示できます。 既定では、データは協定世界時 (UTC) を使って表示されます。 ページの右上にある [Period] ドロップダウン メニューで、UTC からブラウザーのタイム ゾーンに、表示されるデータを変更できます。

Period説明
過去 30 分間30 分前からページ表示時点までのデータ。
過去 1 時間1 時間前からページ表示時点までのデータ。
過去 3 時間3 時間前からページ表示時点までのデータ。
過去 12 時間12 時間前からページ表示時点までのデータ。
過去 24 時間(既定) 24 時間前からページ表示時点までのデータ。
過去 7 日間以内7 日前からページ表示時点までのデータ。
過去 31 日間31 日前からページ表示時点までのデータ。
Customユーザーが指定したカスタムの日付と時刻範囲のデータ。 カスタム範囲は、過去 31 日以内に開始する必要があります。

organization の API 分析情報を表示する

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. Organizationの名前をクリックしてください。

  3. 組織名の下にある [分析情報] をクリックします。

    組織の水平ナビゲーション バーのスクリーンショット。 グラフ アイコンと [分析情報] というラベルのタブが、濃いオレンジ色の枠線で強調されています。

  4. [Insights] ナビゲーション メニューで、[REST API] をクリックします。

  5. API 分析情報を表示する期間を選ぶ必要がある場合は、ページの右上にある [Period] ドロップダウン メニューからオプションを選びます。 詳細については、「API 分析情報の集計について」を参照してください。

  6. 日付と時刻の表示を、協定世界時 (UTC) と、ブラウザーで使われているローカル タイム ゾーンの間で切り替える必要がある場合は、ページの右上にある [Period] ドロップダウン メニューから [UTC] または [Local] を選びます。

  7. グラフに表示する REST API 要求の詳細さを選ぶ必要がある場合は、ページの右上にある [Interval] ドロップダウン メニューからオプションを選びます。 間隔が大きいと、API アクティビティの要約がグラフに表示され、間隔が小さいと、選んだ期間の詳細が表示されます。 グラフが自動的に更新されて新しいアクティビティが表示されることはありません。

選んだ期間と間隔は自動的にページの URL の一部になるため、URL を他のユーザーと共有すると、同じビューが表示されます。

organization のアプリとユーザーの API 分析情報を表示する

"アクター" テーブルには、選ばれている期間内に現在の organization で REST API 要求を行った GitHub Apps とユーザーが表示されます。 テーブルが自動的に更新されて新しいアクティビティが表示されることはありません。

  1. 最初に、前に説明した「Organization の API 分析情報を表示する」の手順を使って organization の API 分析情報を表示します。
  2. "アクター" テーブルに表示されるアプリとユーザーをフィルター処理します。
    1. 名前でフィルター処理するには、"アクター" テーブルの上にある検索フィールドに名前の最初の数文字を入力します。 次に、Enter キーを押します。
    2. アクターの種類 (アプリまたはユーザー) でフィルター処理するには、"アクター" テーブルの右上にある [Type] ドロップダウン メニューからオプションを選びます。
    3. 要求の種類 (すべて、またはプライマリ レート制限) でフィルター処理するには、"アクター" テーブルの右上にある [Requests] ドロップダウン メニューからオプションを選びます。

organization 内の特定のアプリまたはユーザーの API 分析情報を表示する

  1. 最初に、前に説明した「Organization の API 分析情報を表示する」の手順を使って organization の API 分析情報を表示します。
  2. 必要に応じて、"アクター" テーブルでアプリを選び、その REST API アクティビティとプライマリ レート制限を表示します。 結果のビューは、選んだアプリに固有であり、それがアクセスした API エンドポイントが表示されます。
  3. 必要に応じて、"アクター" テーブルでユーザーを選んで、個人の REST API アクティビティを表示します。 結果のビューは、選んだユーザーに固有であり、personal access tokens の API アクティビティと、その代わりに OAuth apps によって行われた要求が表示されます。 どちらも、ユーザーの個人プライマリ レート制限に影響します。 ユーザーのプライマリ レート制限と、ユーザーに代わって動作する OAuth apps については、「REST API のレート制限」を参照してください。
    1. ユーザーに代わって行われた REST API アクティビティを表示する必要がある場合は、ユーザー固有のビューで personal access token または OAuth app をクリックします。