Visualización de conclusiones de la API en tu organización

Acerca de las conclusiones de la API

Como propietario de la organización de GitHub Enterprise Cloud, tú y tus usuarios designados podéis ver la actividad de la API REST para toda la organización o aplicaciones y usuarios específicos. Esto te ayuda a comprender los orígenes de la actividad de la API REST y administrarla según tus límites de volumen principales, lo que te proporciona visibilidad sobre el período de tiempo, las aplicaciones y los puntos de conexión de API implicados. Para obtener más información sobre los límites de volumen principales, consulta Límites de volumen de la API de REST.

Habilitación del acceso a las conclusiones de la API

Los propietarios de la organización pueden crear roles de organización personalizados para permitir que los usuarios vean conclusiones de la API para su organización. Para proporcionar acceso a los usuarios, selecciona el permiso View organization API insights al crear un rol de organización personalizado. A continuación, asigna el rol personalizado a un miembro o equipo de la organización. Para más información, consulta Acerca de los roles personalizados de organización.

Comprensión de la agregación de conclusiones de la API

La característica de selección de período de tiempo permite ver las conclusiones de la API durante períodos predefinidos o un período personalizado, tal como se detalla en la tabla siguiente. De forma predeterminada, los datos se presentan en hora universal coordinada (UTC). Puedes cambiar los datos que se muestran de UTC a la zona horaria del explorador en el menú desplegable "Period" en la parte superior derecha de la página.

Visualización de conclusiones de la API para una organización

1. En la esquina superior derecha de GitHub, seleccione la foto del perfil y haga clic en Sus organizaciones.

2. Haz clic en el nombre de tu organización.

3. En el nombre del repositorio, haz clic en Información.

   

4. En el menú de navegación "Insights", haz clic en REST API.

5. Opcionalmente, para seleccionar un período de tiempo para ver las conclusiones de la API, elige una opción en el menú desplegable Period de la parte superior derecha de la página. Para obtener más información, consulta Comprensión de la agregación de conclusiones de la API.

6. Opcionalmente, para cambiar entre mostrar fechas y horas en hora universal coordinada (UTC) o la zona horaria local usada por el explorador, selecciona "UTC" o "Local" en el menú desplegable Period situado en la parte superior derecha de la página.

7. Opcionalmente, para seleccionar con qué detalle mostrar solicitudes de la API REST en el gráfico, elige una opción en el menú desplegable Interval situado en la parte superior derecha de la página. Los intervalos grandes muestran resúmenes de la actividad de la API en el gráfico, mientras que los intervalos más pequeños muestran más detalles para el período de tiempo seleccionado. El gráfico no se actualiza automáticamente para mostrar la nueva actividad.

El período y el intervalo seleccionados se convierten automáticamente en parte de la dirección URL de la página para que, en caso de que compartas la dirección URL con alguien, vea la misma vista.

Visualización de conclusiones de la API para las aplicaciones y los usuarios de una organización

En la tabla "Actors" se muestran GitHub Apps y los usuarios que realizaron solicitudes de API REST en la organización actual en el período de tiempo seleccionado. La tabla no se actualiza automáticamente para mostrar la nueva actividad.

1. En primer lugar, consulta las conclusiones de la API para una organización siguiendo los pasos anteriores en Visualización de conclusiones de la API para una organización.
2. Filtra las aplicaciones y los usuarios que se muestran en la tabla "Actors".
   1. Para filtrar por nombre, escribe las primeras letras del nombre en el campo de búsqueda situado sobre la tabla "Actors". Después, presione Entrar.
   2. Para filtrar por tipo de actor (aplicación o usuario), elige una opción en el menú desplegable Type situado encima de la parte superior derecha de la tabla "Actors".
   3. Para filtrar por tipo de solicitud (todas o limitadas por volumen principal), elige una opción en el menú desplegable Requests situado encima de la parte superior derecha de la tabla "Actors".

Visualización de conclusiones de la API para una aplicación o un usuario específicos de una organización

1. En primer lugar, consulta las conclusiones de la API para una organización siguiendo los pasos anteriores en Visualización de conclusiones de la API para una organización.
2. Opcionalmente, selecciona una aplicación en la tabla "Actors" para mostrar tu actividad de la API REST y cualquier limitación de volumen principal. La vista resultante será específica de la aplicación seleccionada y mostrará los puntos de conexión de API a los que ha accedido.
3. Opcionalmente, selecciona un usuario en la tabla "Actors" para mostrar su actividad personal de la API REST. La vista resultante será específica del usuario seleccionado y mostrará la actividad de la API de sus personal access tokens y solicitudes realizados por OAuth apps en su nombre. Ambos contribuyen al límite de volumen principal personal de un usuario. Para obtener información sobre los límites de volumen principales para los usuarios y las OAuth apps que actúan en su nombre, consulta Límites de volumen de la API de REST.
   1. Opcionalmente, en la vista específica del usuario, haz clic en un personal access token o una OAuth app para ver su actividad de la API REST realizada en nombre del usuario.