APIs
10
min de leitura
3 de novembro de 2020

A importância do uso de métricas em API

Luciana Bandeira
Developer Experience
Ajudo desenvolvedores no onboarding e nas melhores práticas de APIs para garantir a melhor Developer Experience. No meu tempo livre me dedico a livros, pesquisar (e degustar) sobremesas e sou apaixonada por viajar.
Mais sobre o autor

Uma das ações que vemos de grande importância, além do uso de APIs disponíveis para consumo, é ser capaz de identificar a experiência e o uso em seu consumo. Com isso, é necessário utilizar várias extrações e análises métricas que podem ser extraídas deste uso de APIs.

Abaixo, listaremos algumas métricas e como elas o apoiarão na identificação do atraso, tanto em desenvolvimento quanto em seu próprio API/Backend.

- Uso de solicitações

Você sabe como identificar quais desenvolvedores/parceiros estão realmente utilizando suas APIs? Você sabe se todas as suas solicitações de processo estão?

Com estas informações, você pode identificar, por exemplo, se um parceiro-chave deixou de usá-las e entrar em contato com ele para identificar o que está acontecendo. Em alguns casos, eles simplesmente pararam de usar devido a perguntas relacionadas a alguma ação e acabaram não tentando resolver esta questão.

- Vista da latência e das interrupções

Ter uma visão de como os APIs estão se saindo é extremamente importante para evitar sobrecarga e indisponibilidade, e para identificar quão saudáveis são o backend e o uso dos APIs.

Visar um ambiente saudável estabelecerá uma utilização estável e sem grandes dificuldades para os parceiros.

- Porcentagem de fracasso x sucesso

Quanto dos APIs é usado e qual é a sua saúde? Ao identificar como está indo sua taxa de sucesso versus fracasso, você pode identificar se seu API proporcionou uma boa experiência para o usuário.

Além disso, vale a pena mencionar que, para considerar um API totalmente saudável, você também deve verificar se os pedidos bem sucedidos que estão sendo feitos não se repetem desnecessariamente (neste caso, a porcentagem pode mascarar o problema dos erros).

- Erros ofensivos

Extraindo estes dados e identificando a maior dificuldade de uso, como a operação, o erro HTTPStatus e a quantidade, é possível identificar se os desenvolvedores têm alguma lacuna de conhecimento de uso e tomar as medidas necessárias, como fornecer treinamento, otimizar a documentação disponível no Portal do Desenvolvedor, promovendo um pontapé inicial.

- APPs de erro ofensivos

Com isto input você será capaz de identificar com precisão os parceiros que têm mais dificuldade em usar, contatando-os assim, podendo identificar a causa do problema e implementar medidas mais fáceis com um gatilho direto e claro.

Mesmo quando pensamos além da visão das APIs, podemos ter mais informações e métricas, como analisar o registro e uso no Portal do Desenvolvedor, podendo assim identificar as pessoas que estão interessadas em usar as APIs, identificando como estão fazendo, o que estão procurando e se as pessoas estão realmente acessando e navegando no Portal.

No post que publicamos há algum tempo, apresentamos algumas ferramentas e análises comportamentais que são aplicáveis ao Portal do Desenvolvedor e podem ajudar na identificação e comportamento de uso tanto da documentação quanto da experiência do usuário e navegabilidade.

Estas foram algumas dicas para extração de métricas no consumo de APIs que podem ser muito perspicazes para suas equipes de TI e de negócios. Através delas, podemos coletar informações úteis para a tomada de decisões, ou mesmo explorar oportunidades que não foram mapeadas anteriormente.

Você tem alguma métrica que você considera essencial? Comente abaixo neste post!

Obrigado pela leitura!