Vonage Reports API Now Supports Video API

Introduction

Vonage Reports API now supports the Video API—but only for Vonage API Dashboard (Unified) users. If you’re an OpenTok Dashboard user, this feature isn’t available.
Until now, developers working with the Video API have relied mainly on the Insights API for detailed session analytics. With this update, you can also access Video data through the Reports API, giving you a single place to pull usage and reporting information across other Vonage APIs such as SMS, Messages, Voice, and Verify.

What Is the Reports API?

The Reports API is a central way to retrieve usage and reporting data across Vonage products, now available for Video, giving developers and businesses a consistent way to track activity, billing, and compliance data.

Why Use The Reports API?

It simplifies reporting by bringing usage and billing data from multiple Vonage APIs into one consistent format. For more information on the Reports API, you can see the launch article here, or read a tutorial on some implementation using Laravel as an example.

Reports API vs. Insights API

Before we dive into how to use the Reports API for Video data, let’s briefly compare it with the Insights and Advanced Insights APIs. The table below highlights the key differences so you can see which product is most applicable to your use case.

All features compared

How to Use the Reports API for Video API Data

Reports API for Video is currently available only through the REST API. It’s not accessible from the Vonage Dashboard, so you’ll need to make your requests using a REST client.

Prerequisites

• Unified Video account

• Your API key & secret

• A REST client (e.g., cURL, Postman)

Step 1. Choose Report Type

• Synchronous reports: Quick results for smaller datasets.

• Asynchronous reports: Better for larger datasets or longer time ranges. Runs in the background and gives you a download link.
  For more details, see Differences Between Synchronous and Asynchronous Operation.

Step 2. Request and Retrieve a Report

2.1 Synchronous Report Example

Send your Request

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"

Example Response (trimmed for clarity)

"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"
        },

See the API reference for synchronous reports for a full breakdown of available fields and their definitions.

2.2 Asynchronous Report Example

Send your Request

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"
  }'

Example Result (CSV) (trimmed for clarity)

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

To keep things simple, I’ve only shown the basics here. For the full step-by-step guide to creating asynchronous reports, please see the article.

Ready to Explore the Reports API for Video?

You can now access your Video API usage and billing data through the Reports API—all in one place. For technical questions about the Reports API for Video, reach out to our Video API Support Team from the support portal. Thinking about moving from OpenTok to Unified? This is a great time to explore enhanced reporting capabilities. Connect with your Account Manager for migration details.