Introducing Vonage Reports API

Introduction

We’re excited to introduce the Vonage Reports API, an API that allows you to see and use your communications data on a centralized platform. Instead of pulling data from multiple sources and stitching them together, you now have a single API that provides a consistent view of your communications, making it faster, simpler, and easier to work with.

Key Features

With the Reports API, you can track delivery status, access billing information, detect potential fraud, and even feed live data into your own dashboards. In short, it’s your single hub for monitoring and managing communications.

No Setup Required

The API is ready to go for every Vonage customer. You just need your API key and secret to start querying.

Complete Data Overview

The Reports API provides a single interface for viewing and managing all your communication data. It consolidates usage data across a wide range of Vonage products, including:

• SMS API, including Traffic Control

• Voice API (In-App Voice, WebSocket calls, Text-to-Speech, ASR, AMD, SIP, PSTN)

• Messages API (WhatsApp, RCS, SMS/MMS, Viber, Facebook Messenger, Instagram)

• Verify

• Network APIs (Identity Insights, including Number Insight)

• Video API

Flexible Pricing Options

We’ve built two ways to pay so you can pick what works best:

• Pay As You Go: Ideal for smaller datasets or occasional queries. You pay per record retrieved.

• Unlimited Plan: A flat monthly fee for high-volume users. Recommended if you’re pulling more than 1 million records per month or 12 million per year.

Two Ways to Retrieve Data

• Synchronous Queries are great for quick, small reports (up to ~10,000 records).

• Asynchronous Queries are designed for big reports, up to ~7 million records at a time.

Advanced Filtering

Filter by date range, event ID, phone numbers, or sub-accounts to retrieve exactly what you need.

Sub-account Management

If your business has multiple sub-accounts, you can query each one separately. This speeds up larger queries and keeps your data organized.

Real-Time Availability

Data is mostly available in real time, though there are some differences depending on the product:

• Voice API: Data is ready as soon as the call finishes.

• Verify API: The data is ready once the workflow is complete. Channel data is available instantly

• Video API: Available within 30 to 120 minutes after processing.

• Most other APIs: Updates happen instantly.

Real-World Use Cases

The Reports API can help you solve a lot of common challenges:

• Usage and Billing Reports: access call detail records and message logs to find invoices and monitor costs.

• Delivery Status Tracking: check the status of a message or call instantly without retrieving an entire dataset.

• Financial Control: generate invoices for sub-accounts, ideal for resellers managing multiple clients.

• Campaign Management: track performance in near real time and adjust campaigns accordingly.

• Fraud Detection: identify fraud patterns and take action using the Fraud Defender product.

• Real-Time Dashboards:  live usage data into BI tools or custom dashboards for instant insights.

Best Practices

Here are a few tips to get the most out of the Reports API:

• Optimizing Requests with Filters: utilize filters (such as date ranges, IDs, or phone numbers) to retrieve only the necessary data, thereby reducing costs and improving efficiency.

• Best Practices for Monitoring Message Status: Request reports using the id parameter with the synchronous method to efficiently track the latest message status without repeated calls.

• Optimizing Requests with All Your Sub-Accounts: For Master accounts with more than 10 sub-accounts, first retrieve the sub-account list via the Sub-accounts API, then call the Reports API separately for each sub-account and for the Master account itself.

• Understanding Pricing and Pay as You Go: Since charges apply per record per report, use the Analytics dashboard to estimate CDR volume and avoid unnecessary duplicate requests.

• Handling Limitations: Stay within the 1 GB asynchronous report size limit and rate limits (5 async or 10 sync requests per second) by chunking requests with filters.

• Choosing Between the Synchronous and Asynchronous Method: Use the synchronous method for smaller, real-time data needs and the asynchronous method for larger datasets or CSV exports across multiple sub-accounts.

• Monitoring API Usage Effectively: Track usage internally or use the free REPORTS-USAGE product to analyze the past 13 months of Reports API activity and optimize performance.

You can get full details of each in our documentation.

Conclusion

The Vonage Reports API is available now, and it’s ready to help you track, analyze, and manage all your communications analytics. Whether your focus is optimizing campaigns, controlling costs, automating billing and usage tracking, or detecting fraud, this API for reporting provides you with full visibility and control. To get started with the Reports API, check out the Reports API documentation and begin building.