Evento de limite de uso da API

Sobre o Evento de limite de uso da API

O evento de limite de uso da API permite que você monitore o uso da API da sua marca e acionador um fluxo de trabalho quando o uso atinge níveis críticos. Você pode monitorar o uso geral da API em sua marca ou restringir o monitoramento a tipos específicos de solicitações de API , erros e usuários.

Configurando um Evento de limite de uso de API

1. Siga o instruções vinculadas para criar um fluxo de trabalho baseado em eventos.
2. Para o evento, escolha Limite de uso da API .
   
3. Selecione sobre o que você gostaria de ser notificado:
   
   • Queda na taxa de sucesso : Acionador o fluxo de trabalho se uma certa porcentagem de solicitações falhar.
   • Tentativas de autenticação com falha (HTTP 401) : O Acionador do fluxo de trabalho ocorre quando um certo número de solicitações falham na autenticação com um erro 401.
   • Atingindo o limite de taxa em toda a marca : Acionador o fluxo de trabalho quando um determinado número ou porcentagem do limite de taxa da sua marca for atingido.
   • Atingindo o limite da API do endpoint (429 erros encontrados) : Acionador o fluxo de trabalho quando um determinado número ou porcentagem de solicitações para um endpoint específico falharem com um erro 429.
   • Pico de chamadas totais para um usuário : Acionador o fluxo de trabalho quando um usuário específico em sua licença enviar um determinado número de solicitações.
   • Pico de sucessos dos anos 200 : Acionador o fluxo de trabalho quando um determinado número ou porcentagem de solicitações for bem-sucedida com uma mensagem 200.
   • Pico de 400s/500s (excluindo 401s e 429s) : Acionador o fluxo de trabalho quando uma certa porcentagem de solicitações estiver falhando com erros 400 ou 500, excluindo erros 401 e 429.
4. Defina o limite para sua notificação. O que você inserir aqui será diferente dependendo do tipo de notificação selecionado.
5. Escolha a frequência com que você gostaria que seu limite fosse verificado:
   • De hora em hora :A cada hora, 15 minutos após o início da hora.
   • Diariamente às 12h UTC
6. Clique em Salvar.
7. Adicionar uma tarefa para seu fluxo de trabalho. Esta será a tarefa que criará a notificação. Tarefas comuns incluem:
   • tarefa de feed de notificações : Crie uma notificação do Qualtrics quando o fluxo de trabalho for acionado.
   • Tarefa de e-mail : Envie um e-mail quando o fluxo de trabalho for acionado.
8. Ao configurar sua tarefa subsequente, você pode usar texto transportado para extrair informações do acionador:
   
   • Ocorrências para evento de domínio de uso de API : O número total de vezes que o tipo de notificação escolhido ocorreu
     Exemplo: Se “Pico de 400s” fosse selecionado, o texto transportado conteria o número de erros 400.
   • Ponto de extremidade da API pública – chamado : Exibe o ponto de extremidade da API específico que foi chamado.
   • Tipo de limite para notificação de domínio de uso de API : Exibe o tipo de notificação de limite que você selecionou.
   • Total de chamadas de endpoint para evento de domínio de uso de API : Se estiver monitorando um determinado ponto de extremidade da API , este é o número total de chamadas feitas para esse ponto de extremidade.
   • ID do usuário que fez as chamadas de API : O ID do usuário que fez as solicitações de API .