Reports API
The [Reports API](/reports/overview) enables you to request a report of activity for your Vonage account. Depending on your query pattern, you can choose from…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 6
- GETList reports
/v2/reports?account_id=abcd1234&status=SUCCESS, FAILED&date_from=2019-06-28T00:00:00-00:00&date_to=2019-06-28T23:59:59-00:00List reports created by the specified account based on filtered provided. - POSTCreate an asynchronous report
/v2/reportsRequest a report on your account activity - GETLoad records synchronously
/v2/reports/records?account_id=abcd1234&product=SMS&direction=inbound&id=aaaaaaaa-bbbb-cccc-dddd-0123456789ab&date_start=2017-12-01T00:00:00+0000&date_end=2018-01-01T00:00:00+0000&include_message=true&show_concatenated=false&status=deliveredFetch usage data synchronously - GETGet status of report
/v2/reports/:report_idRetrieve status and metadata about a requested report. - DELETECancel the execution of a report
/v2/reports/:report_idCancel the execution of a pending or processing report. - GETGet report data
/v3/media/:file_idDownload a zipped archive of the rendered report. The file is available for download for 72 hours.<br> The zip file will be named…
API details
- Base URL
https://api.nexmo.com- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 6 operations on 4 pathsGET 4POST 1DELETE 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2.2.2 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Reports API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Reports API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List reports” (GET /v2/reports?account_id=abcd1234&status=SUCCESS, FAILED&date_from=2019-06-28T00:00:00-00:00&date_to=2019-06-28T23:59:59-00:00), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Reports API?
The [Reports API](/reports/overview) enables you to request a report of activity for your Vonage account. Depending on your query pattern, you can choose from… It is listed under Other and has 6 endpoints.
Who publishes the Reports API?
It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Reports API?
Requests go to https://api.nexmo.com. Endpoint paths are added to this base URL.
How do I authenticate with the Reports API?
With HTTP Basic authentication (username and password).
How many endpoints does the Reports API have?
6 operations on 4 paths (4 GET, 1 POST, 1 DELETE).
Is forking the Reports API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.