Export the dashboard as an excel file using API

Feature Suggestions
1

I know that I can download a set of reports within a single dashboard in an Excel file with multiple sheets based on the number of reports through email. But my suggestion is whether we can do the same thing using an API. I’ve felt the need for this a lot recently, where I need to export the dashboard but through the API, and I hope it follows the same method and options as the email.

Note:
Not the canvas dashboard. I mean the normal dashboard if I can call it like that. Below an example

image

I need to be able using API to export the dashboard with 2 sheets based on the number of reports but not using email. I need to do it using API please.

Thanks

2

Hi @Hamza_rashed :wave:
Thanks for raising this feature suggestion!

As you may have already known, right now our APIs only support exporting each widget into a separate Excel file: Export a Dashboard Widget | Holistics Docs.

See more details on how to export a widget at Get Data.
When the Job is finished, you can download the exported file using the download export API.

Exporting all reports from a dashboard into one single Excel file (with each report as a separate sheet) is currently not available via APIs.
That being said, I can definitely see how it can be a useful addition. Duly noted in our product backlog.

Let me get back to you when there’s an update. Cheers!

1 Like
3

Bumping this feature since we’re looking for something similar, but in PDF format. I’m guessing that they’d likely be implemented together since the download widget API endpoint gives different format options?

4

Hi @anya.conti ,

You can choose pdf in the output field when using the Export Dashboard Widget API to get the PDF file.

image
image1080×1152 45.7 KB

Hope this helps!

5

Hi Tri,

Thanks for the response, but we would like to export the entire dashboard as a PDF via API rather than just one widget. That’s why I’m bumping this feature request for exporting the entire dashboard.

All the best,
Anya

6

Hi @anya.conti,
Currently, our system does not support direct exports of the full dashboard via API. A workaround would be to set up a data schedule via API.
This will send a PDF to your nominated email address. Detailed instructions can be found in our Create Email Schedules using API tutorial. Given that exporting a full dashboard can be time-consuming—especially with numerous widgets—we recommend emailing or sending exported files to SFTP.

There’s a similar community post that you can refer to for reference.

Hope this workaround helps you in this case.

7

Hi Tri,

Ah, that’s helpful, thanks! That might work for us. It does feel a little messy, so definitely still want to bump this feature request. But in light of the workaround, not as high priority.

Thanks,
Anya

1 Like
8

Glad it helps! I’ll log this in the backlog and raise this with our team.

1 Like