Skip to main content
cancel
Showing results for 
Search instead for 
Did you mean: 

The Power BI Data Visualization World Championships is back! It's time to submit your entry. Live now!

Reply
KieranNZ
Frequent Visitor

PBIE Report Visuals API Endpoint

I understand that we can embed individual visualizations, however getting a list of visuals on a report or report page is not straight-forward. This is the current workaround as I understand it: How to get pages and visuals lists via REST API 

 

Would it be possible to get an endpoint for visuals? ie.

/reports/<reportId>/visuals

or 

/reports/<reportId>/pages/<pageName>/visuals

2 REPLIES 2
Hariharan_R
Solution Sage
Solution Sage

Hi

  We dont have direct rest api end point for report visuals. 

 

Ref - https://docs.microsoft.com/en-us/javascript/api/overview/powerbi/embed-visual

Refer this to get the visual id - https://dataap.org/blog/2022/03/10/export-power-bi-report-visual-as-a-image-rest-api-automated-way/

 

Thanks

Hari

Anonymous
Not applicable

Hi  @KieranNZ ,

Please review the following links and check whether they are what you want. Hope they can help you resolve the problem...

Get pages and visuals

let pages = await page.getVisuals();

Getting The IDs Of All Visuals In A Power BI Report Page Using The Power BI Embedded Analytics Playg...

yingyinr_0-1650264099965.gif

Get visuals from Power BI report through API Call

You cannot get them with the REST API but you can with the Javascript API

If you did the following to embed your report

var report = powerbi.embed(reportContainer, config);

You could then do the following PowerBI Javascript API call to get all of the visuals on the first page of the embedded report and store them in a MyReportVisuals variable to do whatever you want with.

report.getPages().then(pages => {
            pages[0].getVisuals().then(visuals => MyReportVisuals = visuals)
        });

Best Regards

Helpful resources

Announcements
Power BI DataViz World Championships

Power BI Dataviz World Championships

The Power BI Data Visualization World Championships is back! It's time to submit your entry.

December 2025 Power BI Update Carousel

Power BI Monthly Update - December 2025

Check out the December 2025 Power BI Holiday Recap!

FabCon Atlanta 2026 carousel

FabCon Atlanta 2026

Join us at FabCon Atlanta, March 16-20, for the ultimate Fabric, Power BI, AI and SQL community-led event. Save $200 with code FABCOMM.