API request via our Quick account

We received a question from one of our client regarding the possibility of retrieving data from our QuickSight dashboards through an API. Is this possible somehow?
They would like to be able to retrieve the status changes per order from the dashboards we have there.

what option are available?

Thank you!

Hi @remba87 and good to see you back in the community!

The documented option for this is the Snapshot Export API. It doesn’t query the dashboard live. Instead, it runs a job that generates a snapshot of the dashboard’s output, which can include up to 5 CSVs or 1 Excel workbook from table or pivot table visuals, plus a PDF if needed. You check the job’s status and then retrieve the generated files, which can also be delivered to an S3 bucket (StartDashboardSnapshotJob). Keep in mind that CSV and Excel exports require the Pixel Perfect Report Add-on, and only table or pivot table visuals can be exported this way, so the order status data would need to be in one of those. Since each job captures the dashboard as of when it runs, your client would need to run it regularly to pick up new status changes.

If your client needs the full underlying data rather than what a visual shows, the export docs note that getting all the data means connecting to the original data source with valid credentials. For order-level status changes, giving the client access to that source, or to an extract from it, may be a better fit than pulling from the dashboard. And if they only need to view the data, Enterprise edition also supports embedding dashboards in a webpage or app (Developing with Quick Sight).

I also found an older community thread with the same question (API to get data shown on a Quick dashboard). The earlier replies there say no API exists, but the most recent one points to the Snapshot API and links a walkthrough video: Programmatic Export to Excel Using the New Snapshot APIs.

Feel free to reply with any questions you have!

Thank you! I will read everything and do other questions in case I need :slight_smile: