L'API Reports de Vonage prend désormais en charge l'API Video

Introduction

L'API Reports de Vonage de Vonage supporte maintenant l Video API-mais seulement pour Vonage API Dashboard (Unified) de Vonage (Unified). Si vous êtes un utilisateur de OpenTok Dashboard cette fonctionnalité n'est pas disponible.
Jusqu'à présent, les développeurs travaillant avec l'API Video s'appuyaient principalement sur l'API API Insights pour obtenir des analyses de session détaillées. Avec cette mise à jour, vous pouvez également accéder aux données Video par le biais de l'API Reports, ce qui vous donne un endroit unique pour obtenir des informations sur l'utilisation et les rapports dans d'autres API de Vonage telles que SMS, Messages, Voiceet Verify.

Qu'est-ce que l'API Reports ?

L'API Reports API est un moyen central d'extraire les données d'utilisation et de reporting des produits Vonage, désormais disponible pour Video, offrant aux développeurs et aux entreprises un moyen cohérent de suivre les données relatives à l'activité, à la facturation et à la conformité.

Pourquoi utiliser Reports API ?

Elle simplifie la création de rapports en rassemblant les données d'utilisation et de facturation provenant de plusieurs API de Vonage dans un format cohérent. Pour plus d'informations sur l'API Reports, vous pouvez consulter l'article de lancement ici, ou lire un tutoriel sur une certaine mise en œuvre en utilisant Laravel comme exemple.

Reports API vs. Insights API

Avant de voir comment utiliser l'API Reports pour les données Video, comparons-la brièvement aux API Insights et Advanced Insights. Le tableau ci-dessous met en évidence les principales différences afin que vous puissiez voir quel produit s'applique le mieux à votre cas d'utilisation.

All features compared

Comment utiliser l'API Reports pour les données de l'API Video

Reports API pour Video est actuellement disponible uniquement via l'API REST. Elle n'est pas accessible à partir du tableau de bord de Vonage, vous devrez donc faire vos demandes à l'aide d'un client REST.

Conditions préalables

• Compte de vidéo unifiée

• Votre clé et votre secret API

• Un client REST (par exemple, cURL, Postman)

Étape 1. Choisir le type de rapport

• Rapports synchrones : Résultats rapides pour les petits ensembles de données.

• Rapports asynchrones : Ils conviennent mieux aux ensembles de données plus importants ou aux périodes plus longues. Il s'exécute en arrière-plan et vous donne un lien de téléchargement.
  Pour plus de détails, voir Différences entre les opérations synchrones et asynchrones.

Étape 2. Demander et récupérer un rapport

2.1 Exemple de rapport synchrone

Envoyez votre demande

curl -X GET "https://api.nexmo.com/v2/reports/records?product=VIDEO-API&account_id=$VONAGE_API_KEY&date_start=2025-09-27T00:00:00Z&date_end=2025-09-30T23:59:59Z" \
-u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

Exemple de réponse (réduit pour plus de clarté)

"records": [
        {
            "account_id": "xxxxx",
            "feature_name": "Subscriber minutes",
            "session_id": "xxxxx",
            "meeting_id": "",
            "subscriber_id": "xxxxx",
            "archive_id": "",
            "broadcast_id": "",
            "hls_id": "",
            "composer_id": "",
            "application_id": "xxxxx",
            "duration": "120.0",
            "date_start": "2025-09-29T11:29:12+00:00",
            "date_end": "2025-09-29T11:30:22+00:00",
            "total_price": "0",
            "currency": "EUR",
            "id": "xxxxx"
        },

Voir la référence API pour les rapports synchrones pour une description complète des champs disponibles et de leurs définitions.

2.2 Exemple de rapport asynchrone

Envoyez votre demande

curl -X POST "https://api.nexmo.com/v2/reports" \
  -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "product": "VIDEO-API",
    "account_id": "$VONAGE_API_KEY",
    "date_start": "2025-09-01T00:00:00Z",
    "date_end": "2025-09-30T23:59:59Z",
    "callback_url": "https://webhook.site/b7dd039b-afc7-464b-8fbd-1ef84820eaed"
  }'

Exemple de résultat (CSV) (réduit pour plus de clarté)

Account_id,feature_name,session_id,application_id,duration,date_start,date_end,total_price,currency
xxxxx,Experience composer,xxxxx,xxxxx,7,2025-09-29T11:30:05+00:00,2025-09-29T11:30:12+00:00,0,EUR
xxxxx,Subscriber minutes,xxxxx,xxxxx,120,2025-09-29T11:29:12+00:00,2025-09-29T11:30:22+00:00,0,EUR
xxxxx,Interconnect,xxxxx,xxxxx,120,2025-09-29T11:29:12+00:00,2025-09-29T11:30:22+00:00,0.0094596,EUR

Par souci de simplicité, je n'ai présenté ici que les principes de base. Pour un guide complet, étape par étape, de la création de rapports asynchrones, veuillez consulter l article.

Prêt à explorer l'API Reports pour Video ?

Vous pouvez désormais accéder à vos données d'utilisation et de facturation de l'API Video via l'API Reports, le tout en un seul endroit. Pour toute question technique concernant l'API Reports pour Video, contactez notre équipe d'assistance API Video à partir du portail d'assistance. Vous envisagez de passer d'OpenTok à Unified ? C'est le moment idéal pour explorer les capacités de reporting améliorées. Contactez votre Account Manager pour plus d'informations sur la migration.