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 usar las alertas de uso de API para monitorizar los volúmenes de solicitudes en las siguientes categorías:

Categoría de API Detalles
Endpoints de REST API Realiza el seguimiento del uso de todas las llamadas a la REST API realizadas al backend de Braze, como el envío de mensajes, la creación de Campaigns o la exportación de usuarios.
Solicitudes de API del SDK Realiza el seguimiento de las solicitudes de API realizadas desde los SDK de Braze en las aplicaciones del cliente, como desencadenar mensajes dentro de la aplicación o sincronizar datos de usuario.

*Solo disponible para clientes que hayan adquirido MAU – CY 24-25.

Crear una alerta de uso de API

Para crear una alerta de uso de 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 endpoints de la REST API y las claves de API sobre los 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 endpoint Track users aumenta en un 100 por ciento en una hora.

Umbrales de alerta

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

Umbrales de alerta
Campo Descripción
Condición del umbral Define las condiciones previas al volumen del umbral sobre el que deseas recibir alertas. Se admiten las siguientes:

  • Increased by o Decreased by: compara las solicitudes con la ventana de tiempo anterior.
  • Increased by percentage o Decreased by percentage: compara el cambio porcentual en las solicitudes con la ventana de tiempo anterior.
  • Greater than or equal o less than or equal: cuenta las solicitudes en una ventana de tiempo.
Volumen del umbral Se utiliza junto con la condición del umbral.
En La ventana de tiempo para la evaluación de la alerta.

Configurar 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 ejemplos como enviar una alerta a plataformas externas, como un canal de Slack. Para ver un ejemplo, consulta nuestra documentación sobre cómo integrar alertas con Slack para nuestras preferencias de notificación.

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

Carga útil de ejemplo

A continuación se muestra una carga útil de ejemplo 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
20

{
  "text": "Your My First API Usage Alert alert has triggered. Please note that this alert is reset every 8 hours, and only one notification will be sent per reset period. You can view your alert and usage here: <link>.",
  "data": {
    "alert_name": "My First API Usage Alert",
    "alert_type": "API Usage Alert",
    "app_group_name": "My Workspace",
    "alert_criteria": {
      "response_codes": "201, 202 and 203",
      "threshold_condition": "increase by",
      "threshold_volume": "50%",
      "within": "1 hour"
    },
    "timeframe_start": "2025-03-20 15:35:00",
    "timeframe_end": "2025-03-20 16:35:00",
    "volume": 1500,
    "previous_timeframe_start": "2025-03-20 14:35:00",
    "previous_timeframe_end": "2025-03-20 15:35:00",
    "previous_volume": 1000
  }
}

Detalles de los campos de la carga útil

Campo Tipo Descripción
text cadena Mensaje de alerta legible para humanos.
data.alert_name cadena Nombre de la alerta.
data.alert_type cadena Tipo de alerta (siempre "API Usage Alert").
data.app_group_name cadena Nombre del espacio de trabajo.
data.alert_criteria.response_codes cadena Códigos de respuesta seleccionados para la alerta. Devuelve "all response codes" si no se selecciona ninguno, un código único como "201", o múltiples códigos como "201, 202 and 203".
data.alert_criteria.threshold_condition cadena Tipo de condición: "increase by", "decrease by", "greater than or equal" o "less than or equal".
data.alert_criteria.threshold_volume cadena o número Valor del umbral. Cuando la condición utiliza un porcentaje, es una cadena que termina en % (por ejemplo, "50%"). Cuando la condición utiliza un valor numérico, es un número (por ejemplo, 50).
data.alert_criteria.within cadena Ventana de tiempo para la evaluación de la alerta (por ejemplo, "1 day").
data.timeframe_start cadena Inicio del período de la alerta en formato UTC YYYY-MM-DD HH:MM:SS.
data.timeframe_end cadena Fin del período de la alerta en formato UTC YYYY-MM-DD HH:MM:SS.
data.volume número Volumen de solicitudes durante el período de la alerta.
data.previous_timeframe_start cadena (Opcional) Inicio del período anterior. Solo presente para condiciones de umbral comparativo.
data.previous_timeframe_end cadena (Opcional) Fin del período anterior. Solo presente para condiciones de umbral comparativo.
data.previous_volume número (Opcional) Volumen de solicitudes durante el período anterior. Solo presente para condiciones de umbral comparativo.

Alertas de ejemplo

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.

Endpoint Clave de API Código de respuesta Condición del umbral Volumen del umbral Dentro de
Todos los endpoints Todas las claves de API 4XX y 5XX Aumento del 10 % 10 1 hora

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

Endpoint Clave de API Código de respuesta Condición del umbral Volumen del umbral Dentro de
/users/track Todas las claves de API 429 Mayor o igual a 100 1 hora

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

Endpoint Clave de API Código de respuesta Condición del umbral Volumen del umbral Dentro de
  • /campaigns/trigger/send
  • /canvas/trigger/send
  • /messages/send
 Todas las claves de API 4XX y 5XX Mayor o igual a 1 1 hora

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

Endpoint Clave de API Código de respuesta Condición del umbral Volumen del umbral Dentro de
Todos los endpoints La clave de API utilizada para tu integración del partner Todos los códigos de respuesta Menor o igual a 0 1 día

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 está notificando 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!