Nexmo Reports

Nexmo Reports is an API for generating and retrieving reports about Nexmo/Vonage communications activity and usage.

• Base URL: https://api.nexmo.com
• Auth: basic (pass your key via the apiKey input)

Operations

• list_reports — GET /v2/reports — List reports
• get_records — GET /v2/reports/records — Load records synchronously
• get_report — GET /v2/reports/{report_id} — Get status of report
• download_report — GET /v3/media/{file_id} — Get report data
• create_async_report — POST /v2/reports — Create an asynchronous report
• cancel_report — DELETE /v2/reports/{report_id} — Cancel the execution of a report

Inputs

• apiKey — your nexmo-reports API key
• operation — one of the operations above
• path parameters when an operation's path contains {...}
• query — optional JSON object of query params
• body — JSON object for create/update ops

Example

operation: list_reports
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• operation
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.