nexmo.com – reports

OpenAPI apis-guru

The 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.

Homepage: https://api.apis.guru/v2/specs/nexmo.com:reports/2.2.2.json
Provider: nexmo.com:reports / reports
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/openapi.yaml

Tools (8)

Extracted live via the executor SDK.

media.downloadReport

Download a zipped archive of the rendered report. The file is available for download for 72 hours.
The zip file will be named <PRODUCT>_<REPORT_ID>.zip
The csv file in the zip archive will be named as report_<PRODUCT>_<ACCOUNT_ID>_<DATE>.csv the date will be formatted as yyyyMMdd.
reports.cancelReport

Cancel the execution of a pending or processing report.
reports.createAsyncReport

Request a report on your account activity
reports.getRecords

Fetch usage data synchronously
reports.getReport

Retrieve status and metadata about a requested report.
reports.listReports

List reports created by the specified account based on filtered provided.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools