Consumo de APIs – Getrak

Visão geral

O relatório Consumo de APIs faz parte do Painel de Relatórios da plataforma Getrak e possui finalidade administrativa, permitindo que a central consulte e acompanhe informações relacionadas à utilização de APIs.
Por meio desse relatório, é possível visualizar a quantidade de requisições realizadas em determinado período, comparar o consumo atual com o período anterior e identificar como as requisições estão distribuídas entre os usuários e os caminhos/rotas (Paths) utilizados.

Essas informações auxiliam no acompanhamento das integrações, na identificação de padrões de utilização e na análise administrativa do consumo dos serviços disponibilizados por API.
O relatório apresenta os dados por meio de indicadores numéricos e gráficos, permitindo uma leitura geral do consumo e uma análise mais detalhada de sua distribuição.

Como acessar

Acesse o menu Relatórios
Clique em Painel de Relatórios
Selecione Consumo de APIs

Ao acessar a funcionalidade, a plataforma apresenta o painel com os indicadores e gráficos relacionados ao consumo de APIs da central.

Tela principal

A tela principal do relatório é organizada em quatro áreas:

Seleção do período de consulta
Aviso sobre a atualização das informações
Indicadores de quantidade de requisições
Gráficos de acompanhamento e distribuição do consumo.

Essa organização permite que o usuário consulte inicialmente o volume geral de utilização e, em seguida, aprofunde a análise por data, usuário ou caminho de requisição.

Seleção do período

Na parte superior direita da tela, está disponível o seletor de período, que por padrão fica selecionado o Mês Atual.
Esse recurso determina o intervalo utilizado como referência para a apresentação dos indicadores e gráficos. A seleção do período permite delimitar a análise e consultar o comportamento do consumo dentro do intervalo disponibilizado pelo relatório.

Exemplo de utilização:

Ao consultar o período Mês Atual, o usuário visualiza as requisições contabilizadas no mês em andamento e pode compará-las com o mesmo intervalo do mês anterior.
A alteração do período deve ser considerada na interpretação de todos os indicadores apresentados na tela, pois os resultados estão vinculados ao intervalo selecionado.

Aviso sobre atualização dos dados

Logo abaixo do título do relatório, a plataforma apresenta um comunicado informativo:
Importante! As informações de consumo podem levar até 2 dias para serem atualizadas no relatório.

Esse aviso indica que os dados apresentados não necessariamente representam o consumo realizado em tempo real. Existe um intervalo de processamento e atualização das informações, que pode chegar a dois dias.

Impacto operacional:

Uma requisição realizada recentemente pode ainda não estar contabilizada
O volume apresentado pode não refletir imediatamente a utilização mais recente
Comparações e análises devem considerar o período de atualização informado.

Recomendação: ao realizar uma conferência administrativa, considere esse intervalo antes de interpretar uma quantidade de requisições como definitiva.

Indicadores de consumo

Na parte superior da tela são apresentados dois indicadores principais, responsáveis por resumir o volume de utilização das APIs.

Requisições (Este mês): Apresenta a quantidade de requisições contabilizadas no período atual.
Qtd. de requisições (mesmo período do mês anterior): A comparação permite identificar diferenças entre o consumo atual e o histórico recente, auxiliando na avaliação de possíveis mudanças no comportamento das integrações.

Gráfico de evolução das requisições

Logo abaixo dos indicadores, a plataforma apresenta um gráfico de linhas que permite acompanhar a quantidade de requisições realizadas ao longo dos dias.
O objetivo é demonstrar visualmente a evolução do consumo e facilitar a comparação entre o período atual e o período anterior.

Eixo horizontal - Dias

Apresenta os dias do período analisado, identificados como Dia 1, Dia 2, Dia 3 e assim sucessivamente. Essa distribuição permite identificar em quais dias houve maior ou menor volume de requisições.

Eixo vertical - Quantidade de requisições

Representa o volume de solicitações contabilizadas em cada dia. Quanto maior a posição do ponto no gráfico, maior a quantidade de requisições registrada naquela data.

Visão por usuário

Essa seção apresenta a distribuição das requisições de acordo com os usuários responsáveis pelo consumo das APIs. O objetivo é permitir que a central identifique quais usuários concentram maior volume de utilização.

A apresentação é realizada por meio de um gráfico de rosca, acompanhado de informações individuais de quantidade e percentual. As informações apresentadas são:

Usuário: Identificação do usuário relacionado às requisições contabilizadas
Quantidade de requisições: Volume de requisições associado ao usuário
Percentual: Participação do usuário no total de requisições considerado pelo gráfico
Gráfico de rosca: Representação visual da distribuição do consumo entre os usuários
Barra de progresso: Representação proporcional da participação de cada usuário.

Visão por Path

A seção Visão por Path apresenta a distribuição das requisições de acordo com os caminhos/rotas utilizados nas chamadas de API.

O Path representa o caminho do recurso ou endpoint acessado durante uma requisição. Essa visão permite identificar quais caminhos concentram maior volume de utilização, contribuindo para uma análise mais direcionada das integrações. As informações apresentadas são:

Path: Identificação do caminho/rota utilizado na requisição
Quantidade de requisições: Número de solicitações associadas ao respectivo caminho
Percentual: Participação daquele caminho no total de requisições considerado
Gráfico de rosca: Representação visual da distribuição das requisições por caminho
Barra de progresso: Demonstra proporcionalmente a participação de cada Path.

Visualização dos dados em tabela

Além dos gráficos de Visão por usuário e Visão por Path, a plataforma mostra as mesmas informações também disponibilizadas em formato de tabela.
Essa apresentação permite consultar os dados de maneira estruturada, facilitando a conferência das quantidades e dos percentuais apresentados nos gráficos.

A visualização tabular é útil quando o usuário precisa comparar informações específicas ou realizar uma análise mais objetiva dos registros.

Quando utilizar o relatório Consumo de APIs

O relatório deve ser utilizado quando houver necessidade de acompanhar ou conferir informações administrativas relacionadas à utilização de APIs.

Entre os principais cenários de utilização estão:

Acompanhamento de consumo: verificar o volume de requisições realizadas em determinado período.
Comparação histórica: identificar diferenças entre o consumo atual e o período anterior.
Análise por usuário: identificar quais usuários concentram maior volume de requisições.
Análise por endpoint: identificar quais Paths são mais utilizados.
Conferência de integrações: utilizar os dados como referência para investigar alterações no comportamento de utilização das APIs.

Relativo a