Anzeigen von API-Erkenntnissen in deiner Organisation

Informationen zu API-Erkenntnissen

Als GitHub Enterprise Cloud-Organisationsbesitzer können du und vorgesehene Benutzer REST-API-Aktivitäten für die gesamte Organisation oder bestimmte Apps und Benutzer anzeigen. Das hilft dabei, die Quellen der REST-API-Aktivität zu verstehen und den primären Ratenbegrenzungen entsprechend zu verwalten. Dadurch gewinnst du Einblicke in den Zeitrahmen, die Apps und die beteiligten API-Endpunkte. Weitere Informationen zu primären Ratenbegrenzungen findest du unter Ratenbegrenzungen für die REST-API.

Aktivieren des Zugriffs auf API-Erkenntnisse

Organisationsbesitzer können benutzerdefinierte Organisationsrollen erstellen, damit Mitarbeiter API-Erkenntnisse für ihre Organisation anzeigen können. Wähle beim Erstellen einer benutzerdefinierten Organisationsrolle die Berechtigung View organization API insights aus, um Benutzern Zugriff zu gewähren. Weise dann die benutzerdefinierte Rolle einem Organisationsmitglied oder Team zu. Weitere Informationen findest du unter Informationen zu benutzerdefinierten Organisationsrollen.

Grundlegendes zur API-Erkenntnisaggregation

Mit dem Feature für die Zeitraumauswahl kannst du API-Erkenntnisse für vordefinierte Zeiträume oder einen benutzerdefinierten Zeitraum anzeigen, wie in der folgenden Tabelle beschrieben. Standardmäßig werden Daten in koordinierter Weltzeit (Coordinated Universal Time, UTC) angezeigt. Du kannst die angezeigten Daten über das Dropdownmenü „Period“ oben rechts auf der Seite von UTC in die Zeitzone deines Browsers ändern.

Anzeigen von API-Erkenntnissen für eine Organisation

1. Wählen Sie in der oberen rechten Ecke von GitHub Ihr Profilfoto aus, und klicken Sie dann auf Ihre Organisationen.

2. Klicke auf den Namen Deiner Organisation.

3. Klicke unter dem Namen deiner Organisation auf Erkenntnisse.

   

4. Klicke im Navigationsmenü „Insights“ auf REST API.

5. Um einen Zeitraum auszuwählen, für den API-Erkenntnisse angezeigt werden sollen, wähle optional im Dropdownmenü Period oben rechts auf der Seite eine Option aus. Weitere Informationen findest du unter Grundlegendes zur API-Erkenntnisaggregation.

6. Um zwischen der Anzeige von Datums- und Uhrzeitangaben in koordinierter Weltzeit (UTC) oder der von deinem Browser verwendeten lokalen Zeitzone zu wechseln, wähle optional im Dropdownmenü Period oben rechts auf der Seite „UTC“ oder „Local“ aus.

7. Um auszuwählen, wie präzise REST-API-Anforderungen im Diagramm angezeigt werden sollen, wähle optional im Dropdownmenü Interval oben rechts auf der Seite eine Option aus. Große Intervalle zeigen Zusammenfassungen der API-Aktivität im Diagramm an, während kleinere Intervalle mehr Details für den ausgewählten Zeitraum anzeigen. Das Diagramm wird nicht automatisch aktualisiert, um neue Aktivitäten anzuzeigen.

Der ausgewählte Zeitraum und das ausgewählte Intervall werden automatisch Teil der Seiten-URL, sodass, wenn du die URL mit einer anderen Person teilst, dieselbe Ansicht angezeigt wird.

Anzeigen von API-Erkenntnissen für die Apps und Benutzer einer Organisation

In der Tabelle „Actors“ werden GitHub Apps und Benutzer angezeigt, die REST-API-Anforderungen in der aktuellen Organisation innerhalb des ausgewählten Zeitraums vorgenommen haben. Die Tabelle wird nicht automatisch aktualisiert, um neue Aktivitäten anzuzeigen.

1. Zeige zunächst API-Erkenntnisse für eine Organisation mithilfe oben unter Anzeigen von API-Erkenntnissen für eine Organisation genannten Schritte an.
2. Filtere die Apps und Benutzer, die in der Tabelle „Actors“ angezeigt werden.
   1. Um nach Namen zu filtern, gib die ersten Buchstaben des Namens in das Suchfeld oberhalb der Tabelle „Actors“ ein. Drücken Sie anschließend die EINGABETASTE.
   2. Um nach Akteurtyp (App oder Benutzer) zu filtern, wähle im Dropdownmenü Type oberhalb der oberen rechten Ecke der Tabelle „Actors“ eine Option aus.
   3. Um nach Anforderungstyp („all“ oder „primary-rate-limited“) zu filtern, wähle eine Option aus dem Dropdownmenü Requests über der oberen rechten Ecke der Tabelle „Actors“ aus.

Anzeigen von API-Erkenntnissen für eine bestimmte App oder einen bestimmten Benutzer in einer Organisation

1. Zeige zunächst API-Erkenntnisse für eine Organisation mithilfe oben unter Anzeigen von API-Erkenntnissen für eine Organisation genannten Schritte an.
2. Wähle optional eine App in der Tabelle „Actors“ aus, um die REST-API-Aktivität und alle primären Ratenbegrenzungen anzuzeigen. Die resultierende Ansicht ist auf die ausgewählte App zugeschnitten und zeigt die API-Endpunkte an, auf die sie zugegriffen hat.
3. Wähle optional einen Benutzer in der Tabelle „Actors“ aus, um seine persönliche REST-API-Aktivität anzuzeigen. Die resultierende Ansicht ist auf den ausgewählten Benutzer zugeschnitten und zeigt die API-Aktivität seiner personal access tokens und Anforderungen durch OAuth apps in dessen Namen an. Beide werden auf die persönliche primäre Ratenbegrenzung eines Benutzers angerechnet. Informationen zu den primären Ratenbegrenzungen für Benutzer und OAuth apps, die in deren Namen handeln, findest du unter Ratenbegrenzungen für die REST-API.
   1. Klicke optional in der benutzerspezifischen Ansicht auf ein personal access token oder eine OAuth app, um die REST-API-Aktivität anzuzeigen, die im Namen des Benutzers erfolgt sind.