O que é API Analytics?

A publicação de uma API para consumo externo é apenas uma etapa do ciclo de vida da API. Adquirir uma compreensão mais profunda dos negócios contínuos e do impacto técnico de suas APIs exige uma API Analytics robusta. A adoção bem-sucedida de APIs pelo desenvolvedor requer monitoramento e gerenciamento de todos os aspectos operacionais de um programa de API.

Por que usar API Analytics?

• Obtenha resultados orientados por informações: informações de dados em tempo real sobre o ecossistema – aplicativos, consumo, desempenho e métricas de uso (picos, latência, tempos de resposta) – para obter visibilidade do programa de ponta a ponta
• Gerenciar riscos: as métricas operacionais em tempo real orientam a tomada de decisões e protegem o programa de API contra ataques cibernéticos.
• Melhore a experiência do cliente: crie melhores relacionamentos com os clientes (desenvolvedores e consumidores de API) e conduza decisões com base em informações de dados (meça o envolvimento e o desempenho da API)
• Monitore KPIs: acompanhe e avalie o uso de APIs em produtos, aplicativos, canais e locais.

Perguntas comuns

Responder as perguntas a seguir ajudará você a melhorar sua plataforma de API, resolver problemas e tomar melhores decisões de negócios:

• Como está o desempenho do meu tráfego de API?
• Quais métodos de API são mais populares?
• Quem são os principais desenvolvedores de API?
• Existem problemas que impedem o tempo de resposta?
• Onde está localizado o maior tráfego de API?

Benefícios da API Analytics

Obtenha visibilidade operacional no desempenho da API

Monitore tendências e padrões no uso da API, incluindo latência, taxas de erro, desempenho do cache, padrões de uso e picos de chamadas. Veja os resultados em uma variedade de painéis fáceis de entender para API Analytics inteligente.

Entenda como suas APIs estão sendo usadas

Veja rapidamente quem está usando e como estão usando suas APIs. A API Analytics ajuda você a entender o uso no nível do método para identificar tendências nos padrões de adoção e uso.

Solucionar problemas usando o rastreamento de chamadas da API

Tem problemas com erros de API? Use nosso recurso de rastreamento de chamadas em tempo real para detalhar os fluxos de chamadas da API e ajudar a identificar áreas problemáticas e pontos de falha.

Exportar dados de registro de chamadas para uso externo

Faça do seu jeito. Exporte toda a gama de dados de registro de chamadas de API para o TIBCO Spotfire (ou o ambiente de API Analytics personalizado de sua escolha) e envie os dados de registro para o software de faturamento para monetizar suas APIs.

Obtenha acesso da API a dados de painel e relatórios

Acesse quaisquer dados exibidos nos painéis e relatórios prontos para uso por meio de uma ferramenta de relatório de API para exportação e reutilização programática.

Tipos de relatórios da API Analytics

Alto nível: Resumo executivo

A página Resumo Executivo fornece uma visão de alto nível de seu programa de Interface de Programação de Aplicativos (API), com novas métricas e tendências analíticas em um formato fácil de compartilhar para públicos de stakeholders executivos em toda a sua organização.

O Resumo Executivo foi desenvolvido para fornecer um conjunto abrangente de informações de forma rápida e eficiente, sem a necessidade de coleta de dados e tarefas de análise. O Resumo Executivo é um complemento aos relatórios existentes também disponíveis no painel de administração e foi desenvolvido para um público amplo, como Administradores de API, Gerentes de Produto de API, Executivos de Desenvolvimento de Negócios, Executivos de Marketing e Liderança Executiva Técnica.

Nível médio: Relatórios

Os relatórios fornecem visualizações de dados para auxiliar no monitoramento do desempenho técnico e das métricas de negócios de APIs, pacotes, planos, endpoints e desenvolvedores.

Os usuários acessam relatórios para:

• Visualizar o resumo de uso da API
• Visualizar dados técnicos de desempenho da API
• Visualizar a atividade do desenvolvedor
• Visualizar e analisar a latência da chamada da API
• Visualizar e analisar respostas de erro

Nível baixo: Exportações de registro de chamadas, fluxo de registro de chamadas e inspetor de chamadas

Exportações de registro de chamadas

O recurso Exportações de registro de chamadas permite acessar e filtrar registros de chamadas de API brutos e exportá-los como arquivos CSV. Novos registros são entregues a cada 30 minutos e incluem informações detalhadas de chamadas de API, como endereço IP de origem, URI, nome do serviço e nomes de endpoint. Existem vários casos de uso possíveis para esses dados, incluindo cobrança refinada, detecção de abuso e solução de problemas.

Fluxo de registro de chamadas

A página principal Fluxo de registro de chamadas exibe uma lista navegável de todos os registros do canal Fluxo de registro de chamadas. Você pode acessar as seguintes informações:

• Nome do Canal: O nome do canal do Fluxo de registro de chamadas; o nome padrão é "Canal para o nome da área"
• Status: O status do canal, habilitado ou desabilitado
• Criado em: a data e hora em que o canal foi criado
• Atualizado em: a data e hora em que o canal foi atualizado pela última vez

Call Inspector

O Call Inspector é um recurso de diagnóstico usado para rastrear chamadas de API à medida que passam pelo sistema. Ele fornece informações detalhadas sobre como as solicitações e as respostas realmente aparecem à medida que passam por diferentes pontos. Os clientes podem usar o Call Inspector para casos de uso como solução de problemas de chamadas de API ou suporte a novas integrações. Os dados de chamadas da API podem ser capturados ativando os logs de chamadas para um endpoint e período de tempo especificados.

Métricas de API Analytics

Cada equipe vai querer acompanhar métricas diferentes. As métricas de API para equipes de infraestrutura serão diferentes das métricas de API para equipes de produto. As métricas da API também podem depender do ciclo de vida do produto da API . Por exemplo, uma nova API se concentrará mais em melhorar o design e o uso, enquanto uma API mais antiga poderá se concentrar em recursos adicionais.

Existem quatro grupos principais que dependem das métricas da API:

DevOps

As equipes de DevOps garantem que os servidores estejam funcionando e os recursos limitados sejam alocados corretamente, potencialmente para várias equipes de engenharia.

Existem várias métricas importantes para essa equipe:

• Tempo de atividade
• Utilização do CPU
• Uso de memória

Engenharia de aplicativos

Os desenvolvedores de API adicionam novos recursos às APIs enquanto resolvem problemas na lógica de negócios da API. Eles desenvolvem produtos como plugins, integrações de parceiros, APIs incorporadas e muito mais.

Três métricas importantes para essa equipe são:

• Solicitação por minuto (RPM)
• Latência média e máxima
• Erros por minuto

Gestão de produtos

Os gerentes de produto de API projetam os recursos da API, garantem que os endpoints certos sejam criados e equilibram as necessidades dos clientes com as restrições de tempo.

Algumas métricas importantes para essa equipe são:

• Crescimento do uso da API
• Clientes de API exclusivos
• Principais clientes por uso de API
• Retenção de API
• Tempo para o primeiro Olá Mundo (TTFHW)
• Chamadas de API por transação comercial
• SDK e adoção de versão

Crescimento dos negócios

Equipes voltadas para negócios, como marketing e vendas, normalmente não pensam em termos de endpoints de API. Elas estão mais interessadas na adoção do cliente e em ver quais usuários podem ser novas oportunidades de vendas.

Três métricas importantes para essa equipe são:

• Receita
• Adoção
• Sucesso do cliente