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

Data Days is here! Join us now for 60+ days of learning, challenges, and connection. Learn more

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
Fabric Data Days is here Carousel

Fabric Data Days 2026

Don't miss out on Data Days, June 15 through August 7. Learn Fabric, Power BI, SQL, AI and more.

May Power BI Update Carousel

Power BI Monthly Update - May 2026

Check out the May 2026 Power BI update to learn about new features.

Power BI DataViz World Championships carousel

Power BI DataViz World Championships - June 2026

A new Power BI DataViz World Championship is coming this June! Don't miss out on submitting your entry.

Top Kudoed Authors