Skip to content

Alertas de uso da API

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

Sobre os alertas de uso da API

Você pode usar os alertas de uso da API para monitorar os volumes de solicitação das seguintes categorias:

Criação de um alerta de uso da API

Para criar um alerta de uso da API:

  1. Acesse Configurações > APIs e identificadores > Alertas de uso de API e crie um novo alerta.
  2. Digite um nome para o alerta e escolha os pontos de extremidade da API REST e as chaves de API para os quais você gostaria de ser alertado.
  3. Defina seus critérios de alerta escolhendo um ou mais códigos de resposta e especificando os limites de alerta.
  4. Quando terminar, ative a capacitação do Alerta. Um exemplo de alerta de uso da API que envia notificações quando o ponto de extremidade Rastrear usuários aumenta em 100% em uma hora.

Limites de alerta

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

Configuração de notificações de alerta

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

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

Carga útil da amostra

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."
}

Exemplo de alertas

Aqui estão algumas maneiras de definir suas configurações de alerta 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 de API aumentarem drasticamente, como 20% em relação à hora anterior.

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

Essa configuração de alerta o notifica quando ocorrem erros nas campanhas e Canvas disparados pela API, alguns dos quais podem ser de alta prioridade.

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

Considerações

  • Cada alerta ativo só enviará uma notificação por e-mail ou webhook uma vez a cada 8 horas. Isso serve para evitar muitas notificações de um único alerta. Se o seu alerta estiver notificando-o prematuramente, considere editar os critérios de alerta para que correspondam melhor 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!