Download report file

This code snippet shows you how to retrieve a report file. The report file is a Zipped CSV file containing all the records for the request.


Variable Required Description
VONAGE_API_KEY Yes Your API key which you can obtain from your Dashboard.
VONAGE_API_SECRET Yes Your API secret which you can obtain from your Dashboard.
FILE_ID Yes The file ID of the report to retrieve.

Write the code

Add the following to

Copy to Clipboard

View full source

Run your code

Save this file to your machine and run it:


Try it out

  1. Set the replaceable variables for your account.
  2. Set the FILE_ID. You can obtain this from the details of a get report status or list reports call. The response will contain JSON similar to:

    Copy to Clipboard
        "download_report": {
        "href": ""

    In this case 84a14d67-1234-5678-9012-ac042b16092a is the FILE_ID.

  3. Run the script to download a Zip file containing the report in CSV format.

See also