Skip to content

alertas de uso da API

Os alertas de uso da API fornecem visibilidade crítica sobre o uso da sua API, permitindo que você detecte proativamente tráfego inesperado. Ao configurar esses alertas para monitorar volumes de solicitações da API, você pode receber notificações em tempo real e resolver problemas antes que eles impactem suas campanhas de marketing.

Sobre os alertas de uso da API

Você pode usar alertas de uso da API para monitorar volumes de solicitações para as seguintes categorias:

Criando um alerta de uso da API

Para criar um alerta de uso da API:

  1. Acesse Configurações > APIs e Identificadores > Alertas de Uso da API, e então crie um novo alerta.
  2. Digite um nome para o seu alerta e escolha os endpoints da API REST e as chaves da API para as quais você gostaria de ser alertado.
  3. Defina os critérios do seu alerta escolhendo um ou mais códigos de resposta e especificando os limites de alerta.
  4. Quando terminar, ative Alerta habilitado. Um exemplo de um alerta de uso da API que envia notificações quando o endpoint de Rastrear usuários aumenta em 100 por cento dentro de uma hora.

Limites de alerta

Quando você define seus critérios de alerta, pode ajustar os seguintes limites:

Configurando notificações de alerta

Você pode configurar um alerta de e-mail, um alerta de webhook ou ambos. Alertas de Webhook podem ser muito úteis para casos de uso, como enviar um alerta para plataformas externas, como um canal do Slack. Para um exemplo, veja nossa documentação sobre como integrar alertas com o Slack para nossas preferências de notificação.

Um e-mail será enviado para o e-mail selecionado quando os critérios para o alerta forem atingidos.

Carga útil de exemplo

O seguinte é uma carga útil de exemplo para o corpo de um alerta de uso da API via webhook.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "alert_criteria": {
    	"response_codes": ["201", "202", "203"],
    	"threshold_condition": "Increased by %",
    	"threshold_volume": 50,
    	"within": "1 day"
    },
    "timeframe_start": "2025-03-20T15:35:00Z",
    "timeframe_end": "2025-03-20T16:35:00Z",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20T14:35:00Z",
    "previous_timeframe_end": "2025-03-20T15:35:00Z",
    "previous_volume": 1000
  },
  "text": "Your My First API Usage Alert alert has triggered. You can view your alert and usage here: <link>. Note that this alert will reset in 1 day, as each alert will only send one notification per 8 hours."
}

Exemplos de alertas

Aqui estão algumas maneiras de configurar suas configurações de alerta de uso da API para ser notificado nas seguintes situações.

Você pode configurar alertas para monitorar a integridade geral da sua API. Por exemplo, você pode configurar esses alertas quando os erros da API aumentarem drasticamente, como 20% em relação à hora anterior.

Fique alerta quando seu espaço de trabalho atingir seu limite de frequência para o endpoint /users/track. Você também pode aplicar essa configuração para outros endpoints do Braze.

Essa configuração de alerta notifica você quando ocorrem erros em campanhas acionadas pela API e canvases, algumas das quais podem ser de alta prioridade.

Use a seguinte configuração de alerta para ser notificado quando uma integração com parceiros parar de enviar dados para o Braze.

Considerações

  • Cada alerta ativo enviará apenas um e-mail ou notificação de webhook uma vez a cada 8 horas. Isso é para evitar muitas notificações de um único alerta. Se seu alerta estiver notificando você prematuramente, considere editar os critérios do alerta para melhor corresponder ao seu caso de uso.
  • Você pode ter até 10 alertas por espaço de trabalho.
Github   Editar esta página no GitHub
New Stuff!