Community OpenAPI document · agent-readyAnalyticsBusiness Intelligencebasic6 EndpointsREST
Know of an official OpenAPI document? Contribute it →
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.
Use for: I want to generate a Vonage activity report for last month's SMS traffic, Load voice call records synchronously for the past 24 hours, List all reports my account has run in the last week, Check the status of a report that's still running
Not supported: Does not send messages, place calls, or stream live events - use for after-the-fact activity reporting and CSV export only.
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.
Install Jentic One Beta
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.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fnexmo-reports" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fnexmo-reports" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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.
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
Cancel a long-running report that is no longer needed
Download the generated CSV media file once the report has completed
Use Cases
Patterns agents use Reports 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
GET
/v3/media/{file_id}
Download the CSV output of a completed report
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
R
Reports API
- Foundational (D-)43/100
60
Foundational Compliance70
Developer Experience & Jentic Compatibility78
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
60
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: C+Signals: 4
96%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
42%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
70
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
52%
Example Density
How richly the API is illustrated with examples.
79%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
78
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: A-Signals: 4
68%
Description Coverage
Coverage of descriptions across API elements.
83%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
60%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Vonage Reports API by hand means encoding your API key and secret as HTTP Basic, submitting an asynchronous report job to api.nexmo.com, and downloading the CSV once it completes. Through Jentic you install once, import the Reports API from the API Directory, store the key and secret once, and your agent calls it.
Permission scoping
The Reports API puts the report job id in the URL path (/v2/reports/{report_id}), so you choose the operations your agent may call: you can allow it to create and read report jobs while leaving job deletion out of the allowed set unless you add it.
Credential isolation
Your Vonage API key and secret are stored once, encrypted, by your own Jentic One instance and encoded as HTTP Basic at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a Vonage SMS activity report' and Jentic returns the POST /v2/reports operation with its product and date-range input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Reports 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.
Can I limit what my agent is allowed to do with the Nexmo Reports API?
Yes. Because you run Jentic One yourself, your own rules decide which Reports API operations the agent may call and which stored credentials it may use. For example, you can allow it to create and read report jobs with POST /v2/reports and GET /v2/reports/{report_id}, and download the CSV via GET /v3/media/{file_id}, while leaving DELETE /v2/reports/{report_id} out of the allowed set so the agent cannot cancel jobs. The report job id sits in the URL path, so you scope access per operation rather than handing over the whole account.
GET STARTED