How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vonage

Vonage Reports API

The Reports API from Vonage — 3 operation(s) for reports.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vonage Reports API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 74 JSON Schema definitions.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 106 schemas. It is described by OpenAPI 3.2.0, at version 3.1.4.

Requests are made against a single base URL, https://api.nexmo.com.

4 operations 3 paths 106 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.1.4
Base URL
https://api.nexmo.com
Authentication
HTTP Basic
Contact
Vonage DevRel
License
The MIT License (MIT)
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Vonage Reports API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 4
GET
/v2/reports/records
Load records synchronously
createSyncReportPublic 34 params → 200401403422429500
POST
/v2/reports
Create an asynchronous report
createAsyncReportPublic body → 200400401403422429500
GET
/v2/reports/{reportId}
Get status of report
getAsyncReportPublic 1 param → 200401404429500
DELETE
/v2/reports/{reportId}
Cancel the execution of a report
abortAsyncReportPublic 1 param → 200401404409429500

Schemas 106

The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are MessagesOutboundRecord (30 properties), SmsOutboundRecord (30 properties), VerifyRecord (24 properties), VerifyV2Record (23 properties). Each schema is shown below with its type and property counts.

ConversationMessageFields
object
Conversation Message API
1 property
ConversationMessageReportResponse
Conversation Message
VoiceAsrRecord
object
Voice ASR
16 properties
WEBSOCKET-CALL_ASYNC
Voice WebSocket Call
SmsTrafficControlRecord
object
SMS Traffic Control
6 properties
AMD_ASYNC
Voice AMD (Advanced Machine Detection)
VERIFY-API_ASYNC
Verify v1
NUMBER-INSIGHT_ASYNC
Number Insight v1
ConversationsEventRecordsResponse
Conversations Event
VideoApiRecordsResponse
Video API
NIV1Fields
object
Number Insight API
2 properties
VoiceInAppRecordsResponse
In-App Voice
MessagesOutboundRecord
object
Messages (Outbound)
30 properties
AsrReportResponse
Voice ASR
VideoApiReportResponse
Video API
ReportsUsageFields
object
Reports API usage statistics
MessagesOutboundRecordsResponse
Messages (Outbound)
AsyncRequestFields
object
Fields for asynchronous report requests
2 properties
NETWORK-API-EVENT_ASYNC
Network API Event
VoiceAmdRecord
object
Voice AMD (Advanced Machine Detection)
13 properties
VoiceTtsRecord
object
Voice TTS
22 properties
VerifyV2ReportResponse
Verify v2
AmdReportResponse
Voice AMD (Advanced Machine Detection)
ReportsUsageRecord
object
Reports Usage
18 properties
VOICE-FAILED_ASYNC
Voice Failed
VoiceWebSocketRecordsResponse
Voice WebSocket Call
AmdFields
object
Answering Machine Detection (AMD)
1 property
VoiceRecordsResponse
Voice Call
ErrorResponseWithInvalidParameters
AnyReportResponse
Discriminated Union Schema for All Asynchronous Report Responses
VoiceAmdRecordsResponse
Voice AMD (Advanced Machine Detection)
BaseRequestParams
object
Base parameters for all report requests
4 properties 2 required
ConversationsEventRecord
object
11 properties
WebsocketFields
object
Voice WebSocket Call
1 property
VoiceFailedRecord
object
Voice Failed
15 properties
SmsInboundRecordsResponse
SMS (Inbound)
SmsTrafficControlRecordsResponse
SMS Traffic Control
MessagesInboundRecordsResponse
Messages (Inbound)
ReportResponseBase
object
Base response containing report details and status for async requests
6 properties 6 required
NIReportResponse
Number Insight v1
MessagesInboundRecord
object
Messages (Inbound)
14 properties
NumberInsightRecord
object
Number Insight v1
20 properties
SMS_ASYNC
SMS
CONVERSATION-EVENT_ASYNC
Conversation Event
REPORTS-USAGE_ASYNC
Reports Usage
NetworkApiEventRecordsResponse
Network API Event
VERIFY-V2_ASYNC
Verify v2
SmsOutboundRecord
object
SMS (Outbound)
30 properties
SmsFields
object
SMS
10 properties
ConversationEventFields
object
Conversation Event API
2 properties
VIDEO-API_ASYNC
Video API
AnyAsyncRequestParams
Discriminated Union Schema for All Asynchronous Request Parameters (Request Body)
VideoApiFields
object
Video API
2 properties
VerifyRecord
object
Verify v1
24 properties
VOICE-TTS_ASYNC
Voice TTS
ReportsUsageReportResponse
Reports Usage
MessagesFields
object
Messages API
7 properties
VoiceRejectedFields
object
Voice API rejected call
5 properties
NetworkApiEventRecord
object
Network API Event
17 properties
AsrFields
object
Automatic Speech Recognition (ASR)
4 properties
VoiceRejectedReportResponse
Voice Failed
VerifyV2Record
object
Verify v2
23 properties
ConversationEventReportResponse
Conversation Event
VoiceTtsCallId
string
The unique identifier of the call leg on which the TTS action was performed. Use this field to link a TTS event to the corresponding call leg record in the Voi…
VerifyRecordsResponse
Verify v1
BaseRecordsResponse
object
Base synchronous response containing request metadata and pagination links.
8 properties
VideoApiRecord
object
Video API
17 properties
IN-APP-VOICE_ASYNC
In-App Voice
TierVolume
string
The predefined volume range that applies to the pricing tier for this usage record. Format: "{lowerBound}-{upperBound}" where upperBound can be a number or "on…
ASR_ASYNC
Voice ASR
VoiceWebSocketRecord
object
Voice WebSocket Call
10 properties
VerifyV2Fields
object
Verify v2 API
7 properties
SmsInboundRecord
object
SMS (Inbound)
15 properties
VoiceCallFields
object
Voice API call
7 properties
VerifyReportResponse
Verify v1
VerifyV2RecordsResponse
Verify v2
VoiceInAppRecord
object
In-App Voice
15 properties
AsyncBaseRequest
Base structure for asynchronous report request bodies
VoiceTTSFields
object
Voice Text-to-Speech (TTS)
1 property
MessagesReportResponse
Messages API
VoiceTTSReportResponse
Voice TTS
AnyRecordsResponse
ErrorResponse
object
Base error response following RFC 7807
4 properties 3 required
SmsOutboundRecordsResponse
SMS (Outbound)
InAppVoiceReportResponse
In-App Voice
NumberInsightRecordsResponse
Number Insight
VOICE-CALL_ASYNC
Voice API
ConversationsMessageRecordsResponse
Conversations Message
VerifyV1Fields
object
Number Verify API
2 properties
SmsReportResponse
SMS
SmsTrafficControlFields
object
SMS Traffic Control
VoiceReportResponse
Voice API
VoiceFailedRecordsResponse
Voice Failed
WebsocketReportResponse
Voice WebSocket Call
NetworkApiEventReportResponse
Network API Event
NetworkApiEventFields
object
Network API Event
5 properties
VoiceTtsRecordsResponse
Voice TTS
CONVERSATION-MESSAGE_ASYNC
Conversation Message
ConversationsMessageRecord
object
Conversations Message
15 properties
VoiceAsrRecordsResponse
Voice ASR
ReportsUsageRecordsResponse
Reports Usage
SmsTrafficControlReportResponse
SMS Traffic Control
SMS-TRAFFIC-CONTROL_ASYNC
SMS Traffic Control
VoiceRecord
object
Voice Call
21 properties
MESSAGES_ASYNC
Messages API
InAppVoiceFields
object
In-App Voice
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-reports-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
AE Profile APIs.io
Vonage Advanced API
AE Profile APIs.io
Vonage Application API
AE Profile APIs.io
Vonage Applications API
AE Profile APIs.io
Vonage Archives API
AE Profile APIs.io
Vonage Audio Connector API
AE Profile APIs.io
Vonage Balance API
AE Profile APIs.io
Vonage Basic API
AE Profile APIs.io
Vonage Broadcast API
AE Profile APIs.io
Vonage Calls API
AE Profile APIs.io
Vonage Configuration API
AE Profile APIs.io
Vonage Conversation API
AE Profile APIs.io
#Reports
← Back to V APIs
API Details
ID
vonage:vonage-reports-api
Base URL
https://api.nexmo.com
Docs
https://developer.vonage.com/en/api/sms
Provider
Vonage
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vonage-reports-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vonage-reports-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Vonage Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.