Reports API

Name: Reports API API
Brand: Reports API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAnalyticsBusiness Intelligencebasic6 EndpointsREST

For Agents

Generate, list, cancel, and download asynchronous activity reports across SMS, voice, and verification on a Vonage account, or query records synchronously for ad-hoc analytics.

Connect the Reports API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Reports API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Reports API API.

Create an asynchronous report covering a date range across SMS, voice, or verify activity

Load activity records synchronously for short date ranges and ad-hoc queries

List the reports an account has previously created with their current status

Check the execution status of a specific report and retrieve metadata

GET STARTED

Start building with Reports API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Reports API, keeping it validated and agent-ready.

The Nexmo Reports API exposes activity reporting across SMS, voice, verification, and other Vonage products on a single Vonage account. It supports two patterns — synchronous record loads for ad-hoc queries and asynchronous report generation for large date ranges — plus listing, status checking, cancelling, and downloading the resulting media file. Finance, operations, and growth teams use it to reconcile spend, audit traffic, and export data into a warehouse without scraping the dashboard.

Use Cases

Patterns agents use Reports API API for, with concrete tasks.

★ Monthly billing reconciliation

Finance teams kick off an asynchronous SMS report at the start of each month covering the previous billing period, poll its status until completion, then download the generated CSV from /v3/media/{file_id} to load into the warehouse alongside the Vonage invoice. The async pattern is essential because account-level reports can cover millions of records.

POST /v2/reports for product=SMS and date_start/date_end covering last month, poll GET /v2/reports/{report_id} until status=COMPLETED, then GET /v3/media/{file_id}

Operational ad-hoc lookups

Operations engineers running incident triage need to see the last few hours of voice or SMS records without waiting for a full report job. /v2/reports/records returns the records inline for short windows, which keeps incident response fast and removes the need to schedule and download a full report.

GET /v2/reports/records?product=VOICE&date_start=2026-06-10T00:00:00Z&date_end=2026-06-10T03:00:00Z and inspect the call statuses

Report job orchestration

Data platform teams that automate report generation use the list, status, and cancel endpoints together. A scheduler creates reports daily, a watcher polls /v2/reports for any stuck in PENDING longer than the SLA, and operators call DELETE /v2/reports/{report_id} on jobs that are no longer needed, keeping the report queue clean and predictable.

GET /v2/reports, find any with status=PENDING older than 1 hour, and DELETE /v2/reports/{report_id} on each

AI agent reporting via Jentic

An AI agent that produces weekly Vonage spend summaries can drive the Reports API end-to-end through Jentic. The agent searches for the create-report operation, posts the date range and product, polls the status endpoint, and downloads the CSV media file, all without touching the apiKey or apiSecret directly.

Search Jentic for 'create a vonage activity report', load POST /v2/reports, and execute with product=SMS and the target date range

Key Endpoints

6 endpoints — the nexmo reports api exposes activity reporting across sms, voice, verification, and other vonage products on a single vonage account.

METHOD

PATH

DESCRIPTION

POST

/v2/reports

Create an asynchronous report

GET

/v2/reports

List reports for the account

GET

/v2/reports/{report_id}

Get the status of a specific report

DELETE

/v2/reports/{report_id}

Cancel a running report

GET

/v2/reports/records

Load activity records synchronously

GET

/v3/media/{file_id}

Download the CSV output of a completed report

POST

/v2/reports

Create an asynchronous report

GET

/v2/reports

List reports for the account

GET

/v2/reports/{report_id}

Get the status of a specific report

DELETE

/v2/reports/{report_id}

Cancel a running report

GET

/v2/reports/records

Load activity records synchronously

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Nexmo apiKey and apiSecret are stored encrypted in the Jentic vault and encoded as HTTP Basic on the agent's behalf. Raw credentials never enter the agent's prompt.

Intent-based discovery

Agents search Jentic by intent (e.g. 'create a vonage sms activity report') and Jentic returns the POST /v2/reports operation with the product and date_start/date_end input schema.

Time to first call

Direct integration: 1-2 days to wire up async polling, file download, and Basic auth. Through Jentic: under an hour — search, load, execute, repeat for the polling loop.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Twilio Bulk Exports

Twilio's equivalent bulk export service for messaging and voice activity data.

Choose Twilio Bulk Exports when the underlying traffic was sent through Twilio and you need an equivalent CSV-style export.

Complementary

Nexmo SMS API

SMS traffic sent via the SMS API is one of the primary data sources reported on by the Reports API.

Send through the SMS API in production; report on it via the Reports API after the fact.

Complementary

Nexmo Voice API

Voice activity is one of the products the Reports API can export.

Pair Voice API operational logs with Reports API exports for end-to-end audit trails.

FAQs

Specific to using Reports API API through Jentic.

What authentication does the Nexmo Reports API use?

The Reports API uses HTTP Basic authentication with apiKey as the username and apiSecret as the password. Through Jentic those credentials live in the encrypted vault, are encoded automatically, and the agent only ever sees a scoped token.

Should I use the synchronous or asynchronous endpoint?

Use GET /v2/reports/records for short windows (a few hours of traffic) where you need the data inline. Use POST /v2/reports for anything covering a full day or more — the async pattern handles report generation on Vonage's side, then exposes the result as a downloadable CSV via /v3/media/{file_id}.

What are the rate limits for the Reports API?

The OpenAPI spec does not encode a numeric rate limit. The synchronous /records endpoint will reject queries that span too long a window; the asynchronous flow exists exactly so that long ranges go through the report queue rather than the live request path.

How do I download a report's CSV through Jentic?

Run pip install jentic, search for 'download a vonage report csv', and Jentic returns GET /v3/media/{file_id}. Execute with the file_id returned by the report's status response and Jentic streams the CSV bytes back.

Which Vonage products can I report on?

The product parameter accepts SMS, VOICE-CALL, VERIFY, MESSAGES, and a handful of other Vonage product codes. Each product type returns a distinct set of columns in the CSV, so reports are scoped to one product per job rather than blended across products.

Is the Nexmo Reports API free to call?

Vonage does not charge per report-generation request, but report data ages off according to your account's retention policy. Generate and download reports promptly rather than relying on Vonage to retain raw records indefinitely.