O relatório analítico de consumo de APIs é a tela para análise por endpoints (recursos) das APIs.
Você irá acessar o painel no menu de integrações / APIs / Relatório Analítico

Veja como o Painel está estruturado:

1. Filtros Gerais – Este painel do Relatório Analítico espelha o filtro selecionado no Painel de Consumo de APIs, ou seja, o mês selecionado lá no filtro irá gerar os dados iniciais apresentados aqui.

2. Totalizadores – Os totalizadores também são informações já especificadas no Painel de Consumo das APIs sendo que os dados exibidos aqui têm como condição, os Perfis e a Data Inicial e Data Final selecionado ao lado. 

3. Tabela de Dados – Os dados analíticos apresentados neste relatório visam as seguintes entregas:

   1. Identificar quais recursos ou usuários estão sendo mais utilizados em um dia em que o pacote contratado tenha excedido.

   2. Identificar requisições com falhas ou incorretas.

   3. Identificar se usuários estão acessando recursos não autorizados.

   4. Identificar problemas no processo de integração com as APIs.

   5. As informações contidas nesta tabela agregam os dados de requisições nas APIs totalizando a quantidade por Dia / Usuário / Funcionalidade / Tipo / Resposta; tal como o tamanho do pacote de dados trafegados.

4. Usuário - É o usuário que executou a requisição utilizando o token com seu login e senha.
   
5. Funcionalidade – São as APIs conforme documentação https://api.sienge.com.br/docs/ onde, qualquer granularidade de APIs aninhadas a esta recebem o nome da API pai. Você pode posicionar o mouse sobre a funcionalidade e o sistema te apresentará a URL completa daquelas requisições.
   
   

6. Tipo – É o método utilizado para chamada da API. Atualmente sincronizamos os métodos em 4 informações:

   1. GET – Consulta (utilizado em uma requisição quando se quer buscar dados no Sienge).

   2. POST – Inclusão (utilizado em uma requisição quando se quer adicionar um registro no Sienge ou executar alguma função).

   3. PUT ou PATCH – Edição (utilizado em uma requisição quando se quer alterar registros completos ou parciais respectivamente).

   4. DELETE – Excluir (utilizado quando se quer excluir um registro no Sienge).

   
   

7. Resposta – Após fazer uma requisição por API o usuário recebe uma mensagem de resposta, esta mensagem tem grupos de códigos que identificam o tipo de resposta, conforme abaixo.

   1. Respostas de informação (100-199) - Resposta provisória indica que tudo ocorreu bem até agora e que o cliente deve continuar com a requisição ou ignorar se já concluiu o que gostaria

   2. Respostas de sucesso (200-299) – Acontece quando a requisição não obteve erros e a solicitação foi executada com sucesso.

   3. Redirecionamentos (300-399) - Acontece quando ao se fazer uma requisição ao sistema, o link não está mais disponível naquele endereço e por isso há um redirecionamento para outra página.

   4. Erros do cliente (400-499) – Existem muitas possibilidades diferentes, mas acontece quando cliente faz a requisições de forma inválida, tanto em relação às suas credenciais ou endpoints não encontrado.

   5. Erros do servidor (500-599) – Erros acontecidos no lado do Sienge por motivos diversos.
      
      

8. Quantidade – A soma de requisições do agrupamento de: Dia / Usuário / Funcionalidade / Tipo / Resposta. Exemplo: 

   Dia: 04/05/2020
   Usuário: teste-api
   Funcionalidade: Títulos a Pagar
   Tipo: Consulta
   Resposta: 200 Sucesso

   
   

   A quantidade é a soma das requisições do usuário teste-api feitas no dia 04/05/2020 de consulta na API de Títulos a Pagar que foram bem-sucedidas.

   
   

   Como diversas requisições podem ter este mesmo agrupamento, o sistema as agrupa para dar maior visibilidade do quantitativo.

   
   

9. Tamanho – A soma do tamanho dos pacotes de dados das requisições do agrupamento de: Dia / Usuário / Funcionalidade / Tipo / Resposta.
   
   Esperamos que este artigo tenha ajudado!