Dashboard de uso de la API
El dashboard de uso de la API te permite monitorizar el tráfico entrante de la REST API hacia Braze para comprender las tendencias en tu uso de nuestras REST API y solucionar posibles problemas.
Acerca del panel de uso de la API
Para ver tu panel de uso de la API, ve a Configuración > API e identificadores y selecciona Panel.
El panel predeterminado es una vista de todas las solicitudes entrantes de la REST API para tu espacio de trabajo durante el último día (24 horas). Según tu caso de uso, puedes ajustar los controles del panel para filtrar o agrupar el tráfico y también configurar el rango de tiempo del panel.
Métricas disponibles
El panel de uso de la API incluye las siguientes estadísticas:
| Métrica | Descripción |
|---|---|
| Total de solicitudes | El número total de solicitudes enviadas a Braze para tu espacio de trabajo actual, según los filtros y controles aplicados al panel. |
| Tasa de éxito | El porcentaje del total de solicitudes en las que Braze devolvió una respuesta de éxito 2XX. |
| Tasa de error | El porcentaje del total de solicitudes en las que Braze devolvió una respuesta de error 4XX o 5XX. |
Uso del panel
Filtros
Selecciona Filtros para aplicar filtros que limiten la vista del tráfico de la REST API en tu espacio de trabajo, incluyendo:
- Clave de API
- Endpoint
- Código de respuesta
Agrupación de datos
Puedes agrupar los datos en varias series de datos para explorar diferentes patrones en tu uso, incluyendo:
- Códigos de respuesta (predeterminado)
- Endpoint de API
- Clave de API
- Solo éxitos y fallos
Fecha
Ajusta el filtro de fecha para mostrar un intervalo de tiempo más pequeño o mayor según sea necesario. Esto incluye:
- Hoy (predeterminado)
- Personalizado
- Últimas 3 horas
- Últimas 6 horas
- Últimas 12 horas
- Últimas 24 horas
- Ayer
- Últimos 7 días
- Últimos 14 días
- Últimos 30 días
- Último mes hasta la fecha
Las opciones de Últimas 3 horas y Últimas 6 horas mostrarán el tráfico por minutos. Los períodos de tiempo más largos mostrarán el tráfico cada cinco minutos, hora o día.
Consideraciones
El panel de uso de API incluye todas las solicitudes de REST API que Braze recibió y para las que devolvió una respuesta 2XX, 4XX o 5XX. Esto incluye las salidas de Data Transformation y las sincronizaciones de Cloud Data Ingestion. El tráfico del SDK y los pasos de User Update no se incluyen en este panel.
Los datos mostrados en el panel pueden tener un breve retraso para mostrar el tráfico reciente. Durante períodos de uso elevado, puedes actualizar el panel hasta 4 veces por minuto. Es posible que debas esperar unos minutos antes de actualizar el panel de nuevo.
Claves de API en el cuerpo de la solicitud
Cuando las claves de API se envían en el cuerpo de la solicitud en lugar del encabezado de solicitud, es posible que algunas solicitudes no aparezcan en el panel de uso de API. Esto puede generar datos incompletos en el panel y dificultar el monitoreo preciso del uso de API.
Para obtener los informes más precisos en el panel de uso de API, incluye las claves de API en el encabezado de solicitud en lugar de en el cuerpo de la solicitud.