Como ver os insights de API na sua organização

Sobre os insights de API

Como proprietário da organização do GitHub Enterprise Cloud, você e os usuários designados podem ver a atividade da API REST de toda a sua organização ou de aplicativos e usuários específicos. Isso ajuda você a entender as origens da atividade da API REST e a gerenciá-las em relação aos limites de taxa primária, proporcionando visibilidade do tempo, dos aplicativos e dos pontos de extremidade de API envolvidos. Para saber mais sobre os limites de taxa primária, confira Limites de taxa para a API REST.

Como habilitar o acesso aos insights de API

Os proprietários da organização podem criar funções de organização personalizadas para permitir que as pessoas vejam os insights de API da respectiva organização. Para fornecer acesso aos usuários, selecione a permissão Ver insights de API da organização ao criar uma função de organização personalizada. Em seguida, atribua a função personalizada a um membro ou a uma equipe da organização. Para saber mais, confira Sobre as funções da organização personalizadas.

Noções básicas sobre agregação de insights de API

O recurso de seleção de período permite ver os insights de API em períodos predefinidos ou em um período personalizado, conforme detalhado na tabela a seguir. Por padrão, os dados são apresentados em UTC (Tempo Universal Coordenado). Você pode alterar os dados exibidos de UTC para o fuso horário do navegador no menu suspenso “Período” no canto superior direito da página.

Como ver os insights de API de uma organização

1. No canto superior direito de GitHub, selecione sua foto de perfil e selecione Suas organizações.

2. Clique no nome da sua organização.

3. Sob o nome da organização, clique em Insights.

   

4. No menu de navegação “Insights”, selecione API REST.

5. Opcionalmente, para selecionar um período no qual os insights de API serão exibidos, escolha uma opção no menu suspenso Período no canto superior direito da página. Para obter mais informações, confira Noções básicas sobre agregação de insights de API.

6. Opcionalmente, para alternar entre a exibição de datas e horas em UTC (Tempo Universal Coordenado) ou no fuso horário local usado pelo navegador, selecione “UTC” ou “Local” no menu suspenso Período no canto superior direito da página.

7. Opcionalmente, para escolher a granularidade de exibição das solicitações da API REST no gráfico, escolha uma opção no menu suspenso Intervalo no canto superior direito da página. Os intervalos grandes mostram resumos da atividade de API no gráfico, enquanto os intervalos menores mostram mais detalhes do período selecionado. O gráfico não é atualizado automaticamente para mostrar as novas atividades.

O período e o intervalo selecionados passam automaticamente a fazer parte da URL da página para que, se você compartilhar a URL com alguém, ele veja a mesma exibição.

Como ver os insights de API de aplicativos e usuários de uma organização

A tabela “Atores” exibe os GitHub Apps e os usuários que fizeram solicitações de API REST na organização atual dentro do período selecionado. A tabela não é atualizada automaticamente para mostrar as novas atividades.

1. Primeiro, veja os insights de API de uma organização usando as etapas descritas acima em Como ver os insights de API de uma organização.
2. Filtre os aplicativos e os usuários exibidos na tabela “Atores”.
   1. Para filtrar por nome, insira as primeiras letras do nome no campo de pesquisa acima da tabela “Atores”. Em seguida, pressione Enter.
   2. Para filtrar por tipo de ator (aplicativo ou usuário), escolha uma opção no menu suspenso Tipo acima do canto superior direito da tabela “Atores”.
   3. Para filtrar por tipo de solicitação (todos ou com limite de taxa primária), escolha uma opção no menu suspenso Solicitações acima do canto superior direito da tabela “Atores”.

Como ver os insights de API de um aplicativo ou usuário específico de uma organização

1. Primeiro, veja os insights de API de uma organização usando as etapas descritas acima em Como ver os insights de API de uma organização.
2. Opcionalmente, selecione um aplicativo na tabela “Atores” para ver a respectiva atividade de API REST e qualquer limitação de taxa primária. A exibição resultante será específica do aplicativo selecionado e mostrará os pontos de extremidade de API acessados.
3. Opcionalmente, escolha um usuário na tabela “Atores” para ver a respectiva atividade de API REST pessoal. A exibição resultante será específica do usuário selecionado e mostrará a atividade de API dos respectivos personal access tokens e as solicitações feitas pelo OAuth apps em nome dele. As duas contribuem para o limite de taxa primária pessoal de um usuário. Para obter informações sobre os limites de taxa primária de usuários e sobre os OAuth apps que atuam em nome deles, confira Limites de taxa para a API REST.
   1. Opcionalmente, na exibição específica do usuário, selecione um personal access token ou um OAuth app para ver a respectiva atividade de API REST feita em nome do usuário.