Exporting Dashboard or Visualisations into CSV or PDF via APIs

Hi there, can I enquire if there are QuickSight APIs that can allow custom applications to export dashboard and/or visualisations?

I’ve checked the Quicksight API reference but did not find any related to the above use case.
We are not looking at embedding dashboards but to export specific dashboards as reports to be sent out as emails.

If there isnt any such APIs currently, may I know if there is a roadmap for this?

Thank you!

2 Likes

Hi, we currently do not have APIs to support the export of dashboards and/or visuals. This is a capability that we have on the Product Feature roadmap

2 Likes

Any ETA on this? This would be immeasurably helpful

2 Likes

please advise on this roadmap. this feature is pretty critical to do any form of large scale or automated reporting.

May I ask if the email reporting capabilities meet your needs? You can schedule email reports to be delivered with either or both an image of the sheet and a PDF attachment.

You can also customize these emails in the QuickSight admin console to include custom logos, links, colors, sender and footer.

Is it that you need to customize the emails further? Or you need more custom scheduling options? Or something else?

Hi there, the original use case for my question in Feb was that we needed to send a report with its dashboard filtered specific to each recipient we are sending to.

Just rethinking the original question here, perhaps, for my use case, I should not need an API to export dashboard or visualisations. Instead, if QuickSight already has email reporting capabilities, the idea here might be to provide APIs to trigger these email reporting capabilities so we can tap on this feature for our reporting needs.

For example, a scheduled job on our end calling QuickSight email API based on certain parameters such as:

  • Dashboard ID
  • Sheet Name / Reference
  • Parameter Filter
  • Recipient
  • (and the other customization options you’ve mentioned)

As mentioned by @hilton_smith, we think such APIs (not sure if his use case is similar to mine) are very suitable for large-scale automated reporting.

To add to this - we have a range of use-cases where an API could be helpful (e.g. publish to a wiki or chat channel). The scheduled email is kind of helpful, but there are definitely use-cases beyond this.
And a key limitation of the email PDF is the fact it can only do a single page of course. I think multi-page is somewhere on the roadmap, and I can see that helping a bit.

@bang Thank you for sharing more details. Just so you know, email reports respect both row-level security and dynamic parameter defaults, so if you schedule an email report on a dashboards that uses either, each user’s emails will look different and they will see data specific to them.

I dont disagree with you that having an API to trigger them on a more custom schedule would be great. We will make down your request internally.

@JRK Understood. You are correct that paginated PDFs are on the roadmap. Unfortunately I cant comment on exactly when, but stay tuned :wink:

1 Like

@Jesse thanks for raising the point on row-level security and dynamic parameters. This may help us somewhat, we’ll explore that!

1 Like

@Jesse
Our use case involves Embedded dashboards using anonymous login and parameters to filter data appropriately for the user in our web application. Currently embedded dashboards do not allow a user to schedule email delivery. We’ve developed our own custom email scheduling system, but would like to tie into Quicksight further to include a PDF snapshot at the time the email is generated.

1 Like

@LexusHam acknowledged. We have a number of customers using anonymous embedding who also want to send email reports, and this is something the product team is currently looking into (to generate those assets programmatically).

3 Likes

@Jesse , In my scenario, I am good with the email of Dashboard, Paginated reports as PDFs!
I also want to store the PDFs somewhere like S3 so that I can use it on my web application workflows etc,.
Can you please help me here to understand is there any other I can export the Dashboard or Reports? Appreciate your help!

Hello everyone,

Do we have an API or a solution for Scheduling the reports yet?
Specifically, I am looking to build a feature in my application that will allow users to schedule QuickSight reports without having to manually schedule them within the QuickSight console.
cc-@jesse

Thank you in advance.

Not quite but getting close :slight_smile:. Stay tuned

@Jesse

Hi, is there any ETA on this? I would like to be able to export pdf reports for a number of different subjects (RLS enabled) using either boto3 or the CLI.

Thanks,
Lewis

Targeting end of this month (subject to change). Almost there! Just FYI you will need to be using the Paginated Reporting add-on in order to use the Export APIs.

The Export APIs have now been released, please see What’s New Post here for more details: Amazon QuickSight now supports Snapshot Export APIs

Hi @Jesse @Rahul_Easwar
Is there a option to export CSV, PDF, Excel for Quicksight registered users via APIs. Currently the snapshot API is available only for anonymous users with row level permission tags.

Hi @MohanapriyaA - right now if you want to filter the export to something, you need to configure tag-based RLS fields and set them as you are requesting the export. You can still keep your other RLS enabled which will take effect when users log in to view the dashboard/report.