Informe histórico de Uso de la API

El informe histórico de Uso de la API ayuda a los gerentes y administradores a comprender el uso de la API a lo largo del tiempo. Las tendencias de uso de alto nivel se combinan con datos detallados de los terminales para que pueda hacer seguimiento de los patrones, investigar cambios inesperados y planificar la capacidad. Utilice este informe para:

  • Supervise las llamadas frecuentes a la API a nivel de la aplicación cliente.

  • Profundice en puntos de conexión específicos para comprender los patrones de uso.

  • Entienda cómo cambia el uso de la API día a día o a lo largo del tiempo.

El Informe de Tendencia de Métrica Analytics se basa en datos de dos widgets:

  • Widget de Resumen de Uso de API

  • Widget de Detalle de Uso de API

Clarissa Dalloway administra integraciones con varios sistemas interna que dependen de API. Ella es responsable de mantener estas integraciones estable, seguras y predecibles. Quiere comprender cómo las diferentes aplicaciones cliente y los endpoints utilizan las API a lo largo del tiempo para poder supervisar el consumo, investigar patrones inusuales y planificar el crecimiento futuro.

Clarissa abre el informe histórico de Uso de API. Revisa el widget de Resumen de Uso de API para examinar el volumen de Llamadas a la API por aplicación cliente durante los últimos 30 días. Busca incrementos o disminuciones que coincidan con lanzamientos esperados, cambios de configuración o nuevas integraciones que entren en funcionamiento. Esto le ayuda a confirmar si el uso está dentro de los límites esperados o si hay picos repentinos que podrían causar problemas de rendimiento o capacidad.

Clarissa nota un aumento en el volumen de Llamada a la API que no coincide con ningún evento esperado. A continuación, utiliza el widget API Usage Detail para revisar los conteos de invocación, los endpoints, los códigos de retorno y los ID de aplicación cliente en el día del aumento.

Clarissa observa que una aplicación cliente muestra un aumento considerable en el conteo de invocaciones para un terminal en particular. Utiliza las filas detalladas del widget de API Usage Detail para ver qué métodos, rutas y horas son responsables del aumento repentino, exporta los datos para un análisis más detallado y los comparte con su equipo de desarrollo para que puedan ajustar su integrar y administrar el consumo de la API en el futuro.

Debe contar con estos permisos:

  • Dashboard > Plantillas de tablero > Historial de Uso de API: Activado

  • Dashboard > Cuadros de mando: Ver

  • Dashboard > Cuadros de mando: Editar (opcional)

Si no puede acceder a las plantillas de Reporting o a Dashboard, o si los datos del widget no se están cargando, consulte con su administrador. El administrador puede verificar los permisos de Reporting, Dashboard y widget de su rol visitando Admin > Parámetros de seguridad > Roles y Permisos.

Widget de Resumen de Uso de API

El widget de Resumen de Uso de API proporciona un resumen diario de los volúmenes de Llamadas a la API por aplicación cliente para el período de tiempo seleccionado.

Desde este widget, puede:

  • Vea un resumen del volumen de Llamadas a la API en una o más aplicaciones de cliente a lo largo del tiempo.

  • Valide si los patrones de consumo de la API se alinean con el comportamiento de integración esperado.

Este widget está configurado de la siguiente manera:

  • rango de fechas predeterminado: últimos 30 días

  • rango de fechas máximo: ventana de 95 días

  • Selector de Metrics: Ninguno

Los filtros adicionales para este widget incluyen:

  • Ninguno

La siguiente tabla describe las columnas de este widget:

Nombre de Columna

Descripción

Fecha

Fecha de calendario en la que se realizaron las Llamadas a la API.

Client Application ID

Identificador único de la aplicación cliente que realizó la Llamada a la API.

Nombre de la aplicación cliente

Nombre para mostrar de la aplicación cliente que realizó la Llamada a la API.

Cantidad de Llamadas API

Total número de Llamadas a la API realizadas por la aplicación cliente en la fecha indicada.

Widget de Detalle de Uso de API

El widget de Detalle de Uso de API proporciona información detallada sobre el uso de la API para cada aplicación cliente, fecha, hora, método HTTP y terminal.

Desde este widget, puede:

  • Enfóquese en aplicaciones o métodos de cliente específicos para comprender sus patrones de uso detallados.

  • Exporte los datos a csv o Excel para su posterior análisis o para compartirlos con otros equipos.

Este widget está configurado de la siguiente manera:

  • Rango de fechas predeterminado: Hoy

  • Rango de fechas máximo: ventana de 95 días

  • Selector de Metrics: Ninguno

Los filtros adicionales para este widget incluyen:

  • Método

La siguiente tabla describe las columnas de este widget:

Nombre de Columna

Descripción

Fecha

Fecha del calendario de uso de la API.

Hora

Sello de tiempo del uso de la API.

ID de Aplicación cliente

Identificador único de la aplicación cliente que inició la Llamada a la API.

Nombre de la aplicación de cliente

Nombre para mostrar de la aplicación cliente asociada con el uso de la API.

Método

Método HTTP utilizado en la solicitud de la API.

Ruta de API

Ruta del terminal de la API que se llamó.

Return Code

Código de retorno HTTP de la respuesta de la API.

Conteo de Invocaciones

Número de veces que se invocó la terminal para la fecha, hora, aplicación de cliente, método y código de retorno dados.