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 solicitudes con 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íncronoy 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)
• filtrado 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 real de todas las subcuentas relacionadas con su ID de cuenta principal.
2. Llame a Reports API para cada subcuenta por separado y para su ID de cuenta principal sin subcuentas.

Comprender los precios y el modelo de pago por uso

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

Para hacerse una idea de cuántos CDR puede obtener durante un periodo de tiempo determinado, vaya a Cuadro de mandos 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 manipulación

• Límite del punto final asíncrono - 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 detalles.
• Límites de tarifa - Tenga en cuenta límite de tarifa. 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 desea obtener datos en trozos pequeños más rápidamente, utilice la función síncrono (Es posible obtener un número ilimitado de registros del punto final de sincronización en 1000 trozos de datos).

Si desea obtener conjuntos de datos de mayor tamaño (más de 10.000 registros), utilice la función asíncrono método. El método síncrono es el mejor para los clientes que necesitan datos en tiempo real para sus cuadros de mando o almacenamientos internos. La ventaja del método asíncrono es que permite a los usuarios recibir sus informes como archivos CSV, que pueden utilizarse para análisis manuales posteriores. Además, con el informe asíncrono, los usuarios pueden obtener datos de todas sus subcuentas en un solo informe.

Supervisión eficaz del uso de la API

Implemente la supervisión interna para realizar un seguimiento de sus patrones de uso de la API o utilice la Reports API con el producto. REPORTS-USAGE a obtener información sobre el uso de la API de Reports. Es gratuito, y los datos están disponibles para los últimos 13 meses - esto le ayudará a identificar cualquier posible ineficiencia, optimizar su aplicación, y mantenerse dentro del presupuesto previsto.