
シェア:
ゆかりはVonageのシニア・サポート・エンジニアで、5年前にVideo APIサポート・エンジニアリング・チームに加わりました。サーバーおよびアプリケーションエンジニアリングの経歴を持ち、技術的な深みとカスタマーサクセスの架け橋となっています。
Vonage Reports APIがVideo APIをサポートしました。
所要時間:2 分
はじめに
Vonage Reports APIがサポートされました。 Video APIをサポートしました。-ただし Vonage API Dashboard (Unified)ユーザのみです。ただし OpenTok Dashboardユーザーの場合、この機能は利用できません。
これまで Video API を扱う開発者は主に インサイト APIに頼っていました。今回のアップデートで、Reports API から Video API のデータにもアクセスできるようになり、以下のような他の Vonage API の使用状況やレポート情報を一箇所で取得できるようになりました。 SMS, メッセージ, Voiceそして Verify.
Reports APIとは?
レポート Reports APIは、Vonage製品全体の使用状況やレポートデータを取得するための中心的な方法であり、Videoで利用できるようになり、開発者や企業にアクティビティ、課金、コンプライアンスデータを追跡する一貫した方法を提供します。
Reports APIを使用する理由
複数のVonage APIから利用状況と請求データを1つの一貫したフォーマットに持ってくることで、レポーティングを簡素化します。Reports APIの詳細については、こちらのローンチ記事、またはLaravelを例とした実装のチュートリアルをご覧ください。
Reports API と Insights API の比較
Video データの Reports API の使用方法を説明する前に、Insights および Advanced Insights API と簡単に比較してみましょう。以下の表は、主な違いを示しており、どの製品が自分のユースケースに最も適しているかを確認することができます。
All features compared
Video API データの Reports API の使用方法
Video 用 Reports API は現在 REST API のみで利用可能です。Vonage Dashboardからはアクセスできませんので、RESTクライアントを使用してリクエストを行う必要があります。
前提条件
ユニファイドビデオアカウント
APIキーとシークレット
RESTクライアント(cURL、Postmanなど)
API設定ページを開く API設定ページを開き、Vonage API KeyとSecretにアクセスしてください。両者は以下のスクリーンショットのように表示されます。APIキーはページの上部にあり、APIシークレットにアクセスするには、"Account secret "サブセクションを参照してください。
注:以前に作成したAPIシークレットを覚えていない場合は、"+ Create new secret "をクリックし、安全に保存してください。

ステップ1.レポートの種類を選ぶ
同期レポート:小規模なデータセットでも迅速な結果が得られます。
非同期レポート:大きなデータセットや長い時間範囲に適しています。バックグラウンドで実行され、ダウンロードリンクが表示されます。
詳細は 同期操作と非同期操作の違い.
ステップ2.レポートのリクエストと取得
2.1 同期レポートの例
リクエストを送信
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"回答例(わかりやすくするためにトリミング)
"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"
},を参照してください。 APIリファレンス同期レポートのAPIリファレンスを参照してください。
2.2 非同期レポートの例
リクエストを送信
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"
}'結果例(CSV)(わかりやすくするためにトリミングしています。)
アカウントID,機能名,セッションID,アプリケーションID,期間,開始日,終了日,合計価格,通貨
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物事をシンプルに保つために、ここでは基本的なことだけを紹介しました。非同期レポートを作成するための完全なステップバイステップ・ガイドは 記事.
Video 用の Reports API について調べる準備はできましたか?
Reports API を通して Video API の使用データと課金データにアクセスできるようになりました。Video 用 Reports API に関する技術的なご質問は、以下のサポート ポータルから Video API サポート チームにお問い合わせください。 サポート ポータル.OpenTok から Unified への移行をお考えですか?強化されたレポート機能を検討する絶好の機会です。移行の詳細については、アカウント・マネージャーにお問い合わせください。
ご質問がある場合、またはあなたが作っているものを共有したい場合は、こちらをクリックしてください。
会話に参加する VonageコミュニティSlack
登録する 開発者ニュースレター
フォローする X(旧ツイッター)最新情報
チュートリアルを見る YouTubeチャンネル
LinkedInの LinkedIn の Vonage デベロッパーページ
最新の開発者向けニュース、ヒント、イベント情報をお届けします。