Evento limite de uso de API

Sobre o Evento limite de uso API

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

Configuração de um Evento limite de uso de API

1. Siga as instruções vinculadas para criar um fluxo de trabalho baseado em eventos.
2. Para o evento, escolha o limite de uso API.
   
3. Selecione sobre o que você gostaria de ser notificado:
   
   • Queda na taxa de sucesso: Acionador o fluxo de trabalho se uma determinada porcentagem de solicitações falhar.
   • Tentativas de autenticação com falha (HTTP 401): Acionador o fluxo de trabalho se um determinado número de solicitações falhar na autenticação com um erro 401.
   • Atingir o limite de taxa de toda a marca: Acionador o fluxo de trabalho quando um determinado número ou porcentagem do limite de taxa de toda a marca for atingido.
   • Atingindo o limite API do endpoint (429 erros encontrados): Acionador o fluxo de trabalho quando um determinado número ou porcentagem de solicitações para um ponto de extremidade específico está falhando com um erro 429.
   • Pico do total de chamadas para um usuário: Acionador o fluxo de trabalho quando um usuário específico da sua licença envia um determinado número de solicitações.
   • Pico de sucessos de 200s: Acionador o fluxo de trabalho quando um determinado número ou porcentagem de solicitações for bem-sucedido com uma mensagem 200.
   • Pico de 400s/500s (excluindo 401s e 429s): Acionador o fluxo de trabalho quando uma determinada porcentagem de solicitações estiver falhando com erros 400s ou 500s, 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 deseja que seu limite seja 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. Adicione uma tarefa ao seu fluxo de trabalho. Essa será a tarefa que criará a notificação. As 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: envia um e-mail quando o fluxo de trabalho é acionado.
8. Ao configurar sua tarefa subsequente, você pode usar texto transportado para extrair informações do acionador:
   
   • Ocorrências para o evento domínio de uso api: O número total de vezes que o tipo de notificação escolhido ocorreu
     Exemplo: Se “Spike of 400s” fosse selecionado, o texto transportado conteria o número de 400 erros.
   • Ponto de extremidade API pública – chamado: Exibe o ponto de extremidade específico API que foi chamado.
   • Tipo de limite para notificação de domínio de uso api: Exibe o tipo de notificação de limite que você selecionou.
   • Total de chamadas de endpoint para o evento domínio de uso api: se estiver monitorando um determinado endpoint API, esse é o número total de chamadas feitas para esse endpoint.
   • ID do usuário que fez as chamadas API: A ID de usuário do usuário que fez as solicitações API.