Mock sample for your project: Reports API

Integrate with "Reports API" from nexmo.com in no time with Mockoon's ready to use mock sample

Reports API

nexmo.com

Version: 2.2.2


Use this API in your project

Integrate third-party APIs faster by using "Reports API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
Improve your integration tests by mocking third-party APIs and cover more edge cases: slow response time, random failures, etc.

Description

The Reports API enables you to request a report of activity for your Vonage account.
Depending on your query pattern, you can choose from one of the two versions of the Reports API: asynchronous and synchronous. The asynchronous version is optimized for infrequent and large data queries (from several records to tens of millions). The synchronous version is optimized for frequent and periodic retrievals of small batches of data records (from one record to tens of thousand per query).
Only synchronous version supports retrival of data records by message/record ID.
Vonage recommends that you limit asynchronous queries to a maximum of 20 million records, by setting the start and end dates accordingly. On average, the asynchronous Reports API takes 5 - 10 minutes to generate 1 million records.

Other APIs by nexmo.com

Messages API

The Messages API consolidates and normalises exchanges across all messaging channels. It allows you to use a single API to interact with our various channels such as SMS, MMS, WhatsApp, Viber and Facebook Messenger

Pricing API

The API to retrieve pricing information.
Please note the Pricing API is rate limited to one request per second.

Dispatch API

The Dispatch API enables the developer to specify a multiple message workflow. A workflow follows a template. The first one we are adding is the failover template. The failover template instructs the Messages API to first send a message to the specified channel. If that message fails immediately or if the condition_status is not reached within the given time period the next message is sent. The developer will also receive status webhooks from the messages resource for each delivery and read event. This API is currently in Beta.

Audit API

The Vonage Audit API allows you to view details of changes to your account. More information is available at.
Please note that the Audit API is currently in Beta

Verify API

The Verify API helps you to implement 2FA (two-factor authentication) in your applications. This is useful for:
Protecting against spam, by preventing spammers from creating multiple accounts
Monitoring suspicious activity, by forcing an account user to verify ownership of a number
Ensuring that you can reach your users at any time because you have their correct phone number
More information is available at

Media API

The Media API can be used to query, download and delete media items such as audio files for use with other Nexmo APIs.

Account API

Enables users to manage their Vonage API Account by programmable means. More information is available here:.

Numbers API

The Numbers API enables you to manage your existing numbers and buy new virtual numbers for use with the Vonage APIs. Further information is here:

Voice API

The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls. More information about the Voice API can be found at.

Redact API

The Redact API helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private information from transactional records in the long-term storage. Note, Redact API does not have the capability to redact the short-lived server logs that are retained for a few weeks. For SMS customers that need immediate redaction, Vonage suggests using Advanced Auto-redact.

SMS API

With the SMS API you can send SMS from your account and lookup messages both messages that you've sent as well as messages sent to your virtual numbers. Numbers are specified in E.164 format. More SMS API documentation is at

Subaccounts API

The Subaccounts API enables you to create subaccounts under your primary account. Subaccounts facilitate differential product configuration, reporting, and billing. The Subaccounts API is released initially with restricted availability. You can read more about the API in the Subaccounts documentation.