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:

Categoria da API Informações
Endpoints da REST API Monitora o uso de todas as chamadas da REST API feitas para o backend da Braze, como enviar mensagens, criar campanhas ou exportar usuários.
Solicitações da API do SDK Monitora as solicitações da API feitas a partir dos SDKs da Braze em apps clientes, como acionar mensagens no app ou sincronizar dados de usuários.

*Disponível apenas para clientes que adquiriram Usuários Ativos Mensais – CY 24-25.

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 crie um novo alerta.
  2. Digite um nome para o seu alerta e escolha os endpoints da REST API e as chaves de API para as quais você gostaria de ser alertado.
  3. Defina os critérios do alerta escolhendo um ou mais códigos de resposta e especificando os limites do alerta.
  4. Quando terminar, ative Alerta ativado. Um exemplo de alerta de uso da API que envia notificações quando o endpoint Track users aumenta em 100 por cento dentro de uma hora.

Limites do alerta

Ao definir os critérios do alerta, você pode ajustar os seguintes limites:

Limites do alerta
Campo Descrição
Condição do limite Define as condições que levam ao volume limite sobre o qual você gostaria de ser alertado. As seguintes opções são suportadas:

  • Aumentou em ou Diminuiu em: Compara as solicitações com o período anterior.
  • Aumentou em porcentagem ou Diminuiu em porcentagem: Compara a variação percentual das solicitações com o período anterior.
  • Maior ou igual a ou Menor ou igual a: Conta as solicitações em um período.
Volume do limite Usado em conjunto com a condição do limite.
Entre O período de avaliação do alerta.

Configurando notificações de alerta

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

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

Exemplo de carga útil

A seguir, um exemplo de carga útil para o corpo de um webhook de alerta de uso da API.

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 formas de configurar seus alertas de uso da API para ser notificado nos seguintes cenários.

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

Endpoint Chave de API Código de resposta Condição do limite Volume do limite Entre
Todos os endpoints Todas as chaves de API 4XX e 5XX Aumentou em 10% 10 1 hora

Seja alertado quando seu espaço de trabalho atingir o limite de taxa para o endpoint /users/track. Você também pode aplicar essa configuração para outros endpoints da Braze.

Endpoint Chave de API Código de resposta Condição do limite Volume do limite Entre
/users/track Todas as chaves de API 429 Maior ou igual a 100 1 hora

Essa configuração de alerta notifica você quando ocorrem erros em Campaigns e Canvas disparados por API, alguns dos quais podem ser de alta prioridade.

Endpoint Chave de API Código de resposta Condição do limite Volume do limite Entre
  • /campaigns/trigger/send
  • /canvas/trigger/send
  • /messages/send
 Todas as chaves de API 4XX e 5XX Maior ou igual a 1 1 hora

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

Endpoint Chave de API Código de resposta Condição do limite Volume do limite Entre
Todos os endpoints A chave de API usada para sua integração com parceiros Todos os códigos de resposta Menor ou igual a 0 1 dia

Considerações

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