Rapports d'utilisation

Les Reports API peut fournir des données utiles sur votre Video API l'utilisation. Utilisez ces données pour simplifier la facturation des clients, comparer les modèles d'utilisation et améliorer votre intelligence économique, en transformant les mesures brutes en stratégies de croissance exploitables.

Générer un rapport

Les Reports API fournit des informations détaillées sur les la documentation pour vous guider dans la création de rapports pour votre Video API ou tout autre projet Vonage. Il comprend des instructions étape par étape, des extraits de code et des tutoriels pour vous aider à récupérer et à analyser vos données.

Pour obtenir des informations sur l'utilisation de l'API Video de votre projet, incluez les éléments suivants VIDEO-API comme paramètre de produit lors de la génération du rapport.git

Comment interpréter vos données

Types d'événements

Voici une liste des événements les plus courants et leur signification :

  • Radiodiffusion: Indique le début d'une diffusion. Les diffusions peuvent être utilisées pour diffuser du contenu à plusieurs participants en temps réel.
  • Minutes de l'abonné: Permet de connaître le nombre total de minutes qu'un abonné passe connecté à une session. Utile pour les mesures d'utilisation et les calculs de facturation.
  • Session vidéo: Représente le début d'une session de l'API Video au cours de laquelle les participants se rencontrent, interagissent et partagent de l'audio/vidéo. Cet événement peut être déclenché plusieurs fois pour la même session si plusieurs meeting_id sont générés.
  • Archivage: Indique que l'audio, la vidéo ou les données d'une session ont été enregistrées et stockées en vue d'une récupération ultérieure.
  • HLS: Indique le début d'une diffusion HLS. Veuillez noter que les événements HLS peuvent apparaître avec un retard allant jusqu'à 2,5 heures lorsque la fonction DVR est activée.
  • Interconnexion SIP: Permet de suivre l'utilisation générée par les appels d'interconnexion SIP qui relient les points d'extrémité PSTN/SIP à une session Video API.
  • Connecteur audio: Account for minutes consumed by Audio Connector, which streams session audio to external AI or telephony services.
  • Sous-titres en direct: Capture l'utilisation lorsque les sous-titres en direct sont activés pour fournir une transcription en temps réel au cours d'une session.
  • Compositeur d'expérience: Indique que l'Experience Composer a été ajouté au flux.

Propriétés des événements

account_id: L'identifiant unique de votre Account.

feature_name: Le nom de l'événement suivi. Certains événements sont purement informatifs, tandis que d'autres incluent des données supplémentaires qui fournissent plus de contexte sur l'événement.

session_id: L'identifiant unique d'une session Video API dans laquelle les participants se rencontrent et discutent. Les sessions peuvent être considérées comme des salles virtuelles. Se trouve dans les événements Video Session.

meeting_id: L'identifiant unique d'une réunion créé automatiquement au sein d'une session lorsque les participants s'y joignent. Si une session devient vide et que des participants la rejoignent par la suite, un nouvel identifiant de réunion est généré. Cet identifiant est utilisé uniquement pour suivre l'utilisation de la session dans les rapports.

subscriber_id: L'identifiant unique d'un utilisateur abonné à une session. Disponible pour feature_name valeurs Subscriber_Minutes, SIP_Interconnect, Audio_Connectoret Live_Captions.

archive_id: L'identifiant unique d'un fichier archivé à partir d'une session.

broadcast_id: L'identifiant unique d'une émission. Il peut être utilisé pour obtenir des informations détaillées sur cette diffusion.

hls_id: L'identifiant de l'événement de diffusion HLS. Il correspond à l'identifiant de diffusion.

composer_id: L'identifiant unique de l'Experience Composer utilisé dans la session.

application_id: L'identifiant unique de l'application qui a déclenché l'événement.

duration: Pour les événements temporels, la durée de l'événement.

date_start: La date et l'heure auxquelles l'événement a été déclenché.

date_end: Pour les événements ayant une durée, la date et l'heure de la fin de l'événement. Pour les événements sans durée, cela correspondra à date_start.

total_price: Le coût total associé à l'événement. Pour les événements sans coût, ce champ vaut 0. La devise de ce montant est spécifiée dans le champ currency propriété.

currency: La devise dans laquelle la valeur de l'événement est exprimée. total_price est exprimée.

id: Identifiant unique de l'événement.

Ressources complémentaires

  • Reports API: Apprenez à générer des rapports pour vos applications Vonage.