Buenas prácticas de la API de Reports

Esta página proporciona las mejores prácticas para usar de manera efectiva la API de Reports de Vonage.

Optimización de las solicitudes mediante filtros

Aproveche las opciones de filtrado para adaptar sus solicitudes. Los filtros de Reports API disponibles dependen del producto solicitado. Consulte más detalles en la sección parámetros de consulta para el método síncrono, y en el cuerpo de la solicitud del método asíncrono.

El uso de filtros ayuda a recuperar sólo los datos necesarios, optimizando las llamadas a la API y reduciendo el coste de solicitud del usuario.

Los filtros más populares son:

• filtrar por intervalo de fechas (date_start, date_end)
• filtrar por id para obtener el estado real del evento exacto (mensaje/llamada, etc.) - sólo compatible con el punto final síncrono
• filtrado por números de teléfono (to, frometc.)

Buenas prácticas para supervisar el estado de los mensajes

Para supervisar el estado más reciente del mensaje, debe solicitar el informe mediante la función id parámetro de solicitud - está disponible para el síncrono únicamente. Es un método mucho más eficaz que solicitar los mismos datos varias veces.

Optimización de las solicitudes con todas sus subcuentas

Si tiene previsto solicitar el informe para una cuenta principal con todas sus subcuentas y el número de subcuentas es superior a 10, tenga en cuenta el siguiente flujo para obtener su informe mucho más rápidamente:

1. Llame al API de subcuentas para obtener la lista actualizada de todas las subcuentas vinculadas a tu ID de cuenta principal.
2. Solicita la Reports API para cada subcuenta por separado y para el ID de tu cuenta principal, sin subcuentas.

Comprender los precios y el modelo de tarificación «Pay as You Go»

Con el Pago por uso se le cobrará por registro en el informe. Consulte esta página para ver ejemplos. Si solicitas el mismo CDR en varios informes, se te cobrará varias veces.

Para hacerte una idea de cuántos CDR puedes obtener en un periodo de tiempo determinado, ve a Panel de control y luego ir a la Analítica en el menú de navegación de la izquierda. De este modo, le resultará más fácil calcular el precio de su informe.

Limitaciones de manejo

• Límite de puntos finales asíncronos - Actualmente, puede producir un informe archivado con un máximo de 1 GB. Es decir, unos 7M de registros. Dependiendo del producto, la cifra puede ser mayor para los que tienen menos columnas. Para reducir el número de registros de un informe, intenta obtener los datos en trozos. Puedes filtrar los datos por periodo de tiempo, estado, número de teléfono, etc. Consulte precios Para más información.
• Límites de tarifa - Ten en cuenta que el límite de frecuencia. Reports API admite cinco peticiones por segundo cuando se utiliza de forma asíncrona, y diez peticiones por segundo de forma síncrona. Si se superan estos límites, aparecerá un mensaje HTTP 429: Too Many Requests error.

Elegir entre el método síncrono y el asíncrono

Si quieres obtener datos en pequeños fragmentos más rápidamente, utiliza el síncrono método (Es posible obtener un número ilimitado de registros desde el punto final de sincronización en 1000 bloques de datos).

Si tienes pensado trabajar con conjuntos de datos más grandes (más de 10 000 registros), utiliza el asíncrono método. El método síncrono es el más adecuado para los clientes que necesitan datos en tiempo real para sus paneles de control o sus sistemas de almacenamiento internos. La ventaja del método asíncrono es que permite a los usuarios recibir sus informes en formato CSV, lo que facilita su posterior análisis manual. Además, con el informe asíncrono, los usuarios pueden obtener datos de todas sus subcuentas en un único informe.

Supervisión eficaz del uso de la API

Implementa un sistema de seguimiento interno para analizar los patrones de uso de tu API, o utiliza la Reports API junto con el producto REPORTS-USAGE a obtener información sobre el uso de la API de Reports. Es gratuito y los datos de los últimos 13 meses están disponibles; esto te ayudará a identificar posibles ineficiencias, optimizar tu aplicación y mantenerte dentro del presupuesto previsto.