Skip to content

Alertas de uso de API

Las alertas de uso de API proporcionan una visibilidad crítica del uso de tus API, lo que te permite detectar de forma proactiva el tráfico inesperado. Al configurar estas alertas para realizar el seguimiento de los volúmenes de solicitudes API clave, podrás recibir notificaciones en tiempo real y resolver los problemas antes de que afecten a tus campañas de marketing.

Acerca de las alertas de uso de API

Puedes utilizar las alertas de uso de la API para supervisar los volúmenes de solicitudes de las siguientes categorías:

Creación de una alerta de uso de API

Para crear una alerta de uso de la API:

  1. Ve a Configuración > API e identificadores > Alertas de uso de API y crea una nueva alerta.
  2. Introduce un nombre para tu alerta y elige los puntos finales de la API REST y las claves de API sobre las que deseas recibir alertas.
  3. Define los criterios de tu alerta eligiendo uno o más códigos de respuesta y especificando los umbrales de alerta.
  4. Cuando hayas terminado, activa Alerta habilitada. Un ejemplo de una alerta de uso de API que envía notificaciones cuando el punto de conexión Track users aumenta un 100 por ciento en una hora.

Umbrales de alerta

Cuando definas los criterios de tu alerta, puedes ajustar los siguientes umbrales:

Configuración de notificaciones de alerta

Puedes configurar una alerta por correo electrónico, una alerta por webhook o ambas. Las alertas por webhook pueden ser muy útiles para casos de uso como el envío de alertas a plataformas externas, como un canal de Slack. Para ver un ejemplo, consulta nuestra documentación sobre la integración de alertas con Slack en nuestras preferencias de notificación.

Se enviará un correo electrónico a la dirección seleccionada cuando se cumplan los criterios de la alerta.

Ejemplo de carga útil

A continuación se muestra un ejemplo de carga útil para el cuerpo de un webhook de alerta de uso de 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."
}

Ejemplos de alertas

A continuación se muestran algunas formas de configurar tus alertas de uso de API para recibir notificaciones en los siguientes escenarios.

Puedes configurar alertas para supervisar el estado general de tu API. Por ejemplo, puedes configurar estas alertas cuando los errores de API aumenten drásticamente, como un 20 % respecto a la hora anterior.

Recibe una alerta cuando tu espacio de trabajo alcance su límite de velocidad para el punto de conexión /users/track. También puedes aplicar esta configuración a otros puntos finales de Braze.

Esta configuración de alerta te notifica cuando se producen errores en Campaigns y Canvas desencadenados por API, algunos de los cuales pueden ser de alta prioridad.

Utiliza la siguiente configuración de alerta para recibir una notificación cuando una integración de socio deje de enviar datos a Braze.

Consideraciones

  • Cada alerta activa solo enviará una notificación por correo electrónico o webhook una vez cada 8 horas. Esto es para evitar demasiadas notificaciones de una sola alerta. Si tu alerta te notifica prematuramente, considera editar los criterios de la alerta para que se ajusten mejor a tu caso de uso.
  • Puedes tener hasta 10 alertas por espacio de trabajo.
New Stuff!