Relatório Histórico de Uso de API
O Relatório Histórico de Uso de API ajuda gerentes e administradores a entender o uso da API ao longo do tempo. As tendências de uso de alto nível são combinadas com dados detalhados de terminal para que você possa acompanhar padrões, investigar alterações inesperadas e planejar a capacidade. Use este relatório para:
-
Monitore Chamadas de API frequentes no nível do aplicativo cliente.
-
Investigue endpoints específicos para entender os padrões de uso.
-
Compreenda como o uso da API muda dia a dia ou ao longo do tempo.
O Relatório de Tendência de Métrica Analytics é baseado em dados de dois Widgets:
-
Widget de Resumo de Uso da API
-
Widget Detalhe de Uso de API
Clarissa Dalloway gerencia integrações com vários sistemas internos que dependem de API. Ela é responsável por manter essas integrações estáveis, seguras e previsíveis. Ela quer entender como diferentes aplicativos clientes e endpoints estão usando as API ao longo do tempo, para que possa monitorar o consumo, investigar padrões inusuais e planejar o crescimento futuro.
Clarissa abre o relatório Histórico de Uso de API. Ela analisa o widget Resumo de Uso de API para examinar o volume de Chamadas de API por aplicativo cliente nos últimos 30 dias. Ela procura por aumentos ou diminuições que estejam alinhados com lançamentos esperados, alterações de configuração ou novas integrações entrando em operação online. Isso a ajuda a confirmar se o uso está dentro dos limites esperados ou se há picos repentinos que possam causar problemas de desempenho ou capacidade.
Clarissa percebe um aumento no volume de Chamadas de API que não está alinhado com nenhum evento esperado. Em seguida, ela usa o widget API Usage Detail para observar as contagens de invocação, os endpoints, os códigos de retorno e os IDs de aplicativo cliente no dia do aumento.
Clarissa percebe que um aplicativo cliente mostra um aumento acentuado na contagem de invocações de um determinado terminal específico. Ela usa as linhas detalhadas no widget de detalhes de Uso de API para ver quais métodos, caminhos e horas são responsáveis pelo pico, exporta os dados para análise mais detalhada e os compartilha com sua equipe de desenvolvimento para que eles possam ajustar a integração e gerenciar o consumo da API no futuro.
Você deve ter estas permissões:
-
Dashboard > Modelos de painel > Uso Histórico de API: Ativado
-
Dashboard > Paineis: Visualizar
-
Dashboard > Paineis: Editar (opcional)
Se você não conseguir acessar os modelos de relatório ou Dashboard, ou se os dados do widget não estiverem carregando, consulte o administrador. O administrador pode verificar as permissões de relatório, painel e widget de sua função acessando Admin > Configurações de segurança > Funções e Permissões.
Widget de Resumo de Uso da API
O widget Resumo de Uso de API fornece um resumo diário dos volumes de Chamadas de API por aplicativo cliente para o prazo selecionado.
Nesse widget, você pode:
-
Visualize um resumo do volume de Chamadas de API em um ou mais aplicativos clientes ao longo do tempo.
-
Valide se os padrões de consumo da API estão alinhados com o comportamento de integração esperado.
Este widget está configurado da seguinte forma:
-
Intervalo DE datas padrão: últimos 30 dias
-
Intervalo DE datas máximo: janela de 95 dias
-
Seletor de métricas: Selecione um grupo de perguntas.
Os filtros adicionais deste widget incluem:
-
Selecione um grupo de perguntas.
A tabela abaixo descreve as colunas neste widget:
|
Nome da Coluna |
Descrição |
|---|---|
|
Data |
Calendário com a data em que as chamadas da API ocorreram. |
|
ID do Aplicativo cliente |
Identificador exclusivo do aplicativo cliente que fez a Chamada de API. |
|
Nome do aplicativo cliente |
Nome DE exibição do aplicativo cliente que fez a Chamada de API. |
|
Contagem de chamadas de API |
Total número de Chamadas de API feitas pelo aplicativo cliente na data especificada. |
Widget de detalhes de Uso da API
O widget API Usage Detail fornece informações detalhadas sobre o Uso da API para cada aplicativo cliente, data, hora, método HTTP e terminal.
A partir deste widget, você pode:
-
Concentre-se em aplicativos cliente ou métodos específicos para entender seus padrões de uso detalhados.
-
Exportar os dados para CSV ou Excel para análise adicional ou compartilhamento com outras equipes.
Este widget está configurado da seguinte forma:
-
Intervalo DE datas padrão: Hoje
-
Intervalo DE datas máximo: janela de 95 dias
-
Seletor de métricas: Selecione um grupo de perguntas.
Os filtros adicionais para este widget incluem:
-
Método
A tabela abaixo descreve as colunas neste widget:
|
Nome da Coluna |
Descrição |
|---|---|
|
Data |
Data do calendário do uso da API. |
|
Hora |
Registro de data/hora do uso da API. |
|
ID do Aplicativo cliente |
Identificador exclusivo do aplicativo cliente que iniciou a Chamada de API. |
|
Nome do aplicativo cliente |
Nome DE exibição do aplicativo cliente associado ao uso da API. |
|
Método |
Método HTTP usado na solicitação de API. |
|
Caminho da API |
Caminho do terminal da API que foi chamado. |
|
Código de retorno |
Código de retorno HTTP da resposta da API. |
|
Invocação de Portas Licenciadas somente da Área de Trabalho |
Número de vezes que o terminal foi invocado para a data, hora, aplicativo de cliente, método e código de retorno especificados. |