Informes de uso

En Reports API puede proporcionar datos reveladores sobre su Video API uso. Utilice estos datos para simplificar la facturación a los clientes, comparar patrones de uso y mejorar su inteligencia empresarial, convirtiendo las métricas brutas en estrategias de crecimiento procesables.

Generar un informe

En Reports API proporciona información detallada documentación para guiarle en la generación de informes para su Video API o cualquier otro proyecto de Vonage. Incluye instrucciones paso a paso, fragmentos de código y tutoriales para ayudarte a recuperar y analizar tus datos.

Para obtener información sobre el uso de la Video API en su proyecto, incluya VIDEO-API como parámetro del producto al generar el informe.git

Cómo interpretar los datos

Tipos de actos

He aquí una lista de los acontecimientos más comunes y su significado:

  • Radiodifusión: Indica el inicio de una emisión. Las emisiones pueden utilizarse para transmitir contenidos a varios participantes en tiempo real.
  • Minutos de abonado: Registra el total de minutos que un abonado pasa conectado a una sesión. Útil para las métricas de uso y los cálculos de facturación.
  • Sesión de vídeo: Representa el inicio de una sesión de la Video API en la que los participantes se reúnen, interactúan y comparten audio/vídeo. Este evento puede activarse varias veces para la misma sesión si varios meeting_id se generan.
  • Archivo: Indica que el audio, vídeo o datos de una sesión han sido grabados y almacenados para su posterior recuperación.
  • HLS: Indica el inicio de una emisión HLS. Tenga en cuenta que los eventos HLS pueden aparecer con un retraso de hasta 2,5 horas cuando la función DVR está activada.
  • Interconexión SIP: Registra el uso generado por las llamadas de interconexión SIP que conectan los puntos finales PSTN/SIP a una sesión de Video API.
  • Conector de audio: Account para los minutos consumidos por el Conector de Audio, que transmite el audio de la sesión a servicios externos de AI o telefonía.
  • Subtítulos en directo: Captura el uso cuando los subtítulos en directo están activados para proporcionar transcripción en tiempo real dentro de una sesión.
  • Compositor con experiencia: Indica que el Experience Composer se ha añadido al flujo.

Propiedades de los eventos

account_id: El identificador único de su Account.

feature_name: El nombre del evento que se está siguiendo. Algunos eventos son puramente informativos, mientras que otros incluyen datos adicionales que proporcionan más contexto sobre el evento.

session_id: El identificador único de una sesión de la Video API en la que los participantes se reúnen y chatean. Las sesiones pueden considerarse salas virtuales. Se encuentra en los eventos de Sesión de Vídeo.

meeting_id: El identificador único de una reunión creado automáticamente dentro de una sesión cuando los participantes se unen. Si una sesión queda vacía y los participantes se unen más tarde, se genera un nuevo identificador de reunión. Este identificador se utiliza únicamente para realizar un seguimiento del uso de la sesión en los informes.

subscriber_id: Identificador único de un usuario suscrito a una sesión. Disponible para feature_name valores Subscriber_Minutes, SIP_Interconnect, Audio_Connectory Live_Captions.

archive_id: Identificador único de un fichero archivado de una sesión.

broadcast_id: Identificador único de una emisión. Puede utilizarse para recuperar información detallada sobre esa emisión.

hls_id: Identificador del evento de difusión HLS. Coincide con el identificador de emisión.

composer_id: El ID único del Experience Composer utilizado en la sesión.

application_id: El identificador único de la aplicación que activó el evento.

duration: Para los sucesos temporales, la duración del suceso.

date_start: La fecha y hora en que se activó el evento.

date_end: Para los eventos con duración, la fecha y hora en que finalizó el evento. Para los eventos sin duración, coincidirá con date_start.

total_price: Coste total asociado al evento. Para los eventos sin coste, este campo es 0. La moneda para este importe se especifica en el campo currency propiedad.

currency: La divisa en la que se total_price se expresa.

id: Identificador único del evento.

Recursos adicionales

  • Reports API: Aprende a generar informes para tus aplicaciones de Vonage.