Edit

Best practices for faster performance in Power BI embedded analytics

  • Article

This article provides recommendations for faster rendering of reports, dashboards, and tiles in your application.

Note

Remember that loading time mainly depends on elements relevant to the report and data itself, including visuals, the size of the data, and the complexity of the queries and measures. For more information, see the Power BI optimization guide.

Update tools and SDK packages

Keep tools and SDK packages up-to-date.

Embed parameters

The powerbi.embed(element, config) method receives an element and a config parameter. The config parameter includes fields that have performance implications.

Embed URL

Avoid generating the embed URL yourself. Instead, make sure you get the Embed URL by calling Get reports, Get dashboards, or Get tiles API. The config parameter in the URL is used for performance improvements.

Permissions

Provide View permissions if you don't intend to embed a report in edit mode. This way, time isn't spent initializing components that are only used in edit mode.

Filters, bookmarks, and slicers

Usually, report visuals are saved with cached data. Reports render the cached data while queries are executed. If filters, bookmarks, or slicers are provided, cached data isn't used and the visuals are rendered only after the visual query has ended.

If you embed reports with the same filters, bookmarks, and slicers, save the report with the filters, bookmarks, and slicers already applied. When you save the report this way, it will render using the cached data that includes the filters, bookmarks, and slicers, which improves performance.

Switching between reports

When embedding multiple reports to the same space, don't generate a new iFrame for each report. Instead, embed the new report in the same iFrame to overwrite the previous report. Use powerbi.embed(element, config) with a different config to embed the new report.

Note

Embedding reports using embed for your customers (also known as an 'app owns data' scenario), requires the use of an embed token with permissions to all reports and datasets. For more information, see the generate token API.

Multiple visuals

When embedding several visuals from the same report, don't generate a new iFrame for each visual. Use a single iFrame to render the report with the specified visuals.

When embedding multiple visuals into a single iFrame, consider the following:

  • Power BI uses iFrames to embed a report. Sometimes you might want to add more content between the visuals (for example, text or graphics that don't come from the report). In that case, you may need a different iFrame to render different visuals. For best performance, try and arrange the visuals so that you use the fewest iFrames possible. To reduce the number of iFrames, please consider using the custom-layout feature.

  • If you have visuals from different reports or different datasets, consider joining the datasets and creating a new report so that you can include all the visuals in the same iFrame.

  • Another alternative, if you have non-contiguous regions, or data from multiple datasets, is to create a dashboard and pin the visuals to it. This allows you to:

    • Embed the individual tiles into non-contiguous iFrames. Dashboard tiles are lighter than reports and load faster.
    • Embed the entire dashboard into one iFrame. This allows you to have visuals from different reports or datasets in one iFrame without creating a new report.

    Keep in mind, however, that dashboard tiles aren't interactive and don't refresh with the same frequency as visuals.

Query caching

Organizations with Power BI Premium capacity or Power BI Embedded capacity can take advantage of query caching to speed up reports associated with a dataset.

Learn more about query caching in Power BI.

Preload

Use powerbi.preload() to improve the end-user performance. The method powerbi.preload() downloads JavaScript, css files, and other items, which are used later to embed a report.

Call powerbi.preload() if you're not embedding the report immediately. For example, if the embedded Power BI content doesn't appear in the home page, use powerbi.preload() to download and cache the items that are used for embedding the content.

Bootstrapping the iFrame

Note

Power BI client SDK version 2.9 is required to bootstrap the iFrame.

powerbi.bootstrap(element, config) allows you to start embedding before all required parameters are available. The bootstrap API prepares and initializes the iFrame. When using the bootstrap API, it's still required to call powerbi.embed(element, config) on the same HTML element.

For example, one of the use cases for this feature, is to run the iFrame bootstrap and the back-end calls for embedding, in parallel.

Tip

Use the bootstrap API when it's possible to generate the iFrame before it's visible to the end user.

Learn more about iFrame bootstrap.

Measure performance

Performance events

To measure embedded performance, you may use two events:

  1. Loaded event: The time until the report is initialized (the Power BI logo will disappear when the load is finished).
  2. Rendered event: The time until the report is fully rendered, using the actual data. The rendered event is fired each time the report is re-rendered (for example, after applying filters). To measure a report, make sure you do the calculations on the first raised event.

Cached data is rendered when available but no other event is generated.

Learn more about event handling.

Performance Analyzer

To examine the performance of the report elements, you might use the Performance Analyzer in Power BI Desktop. The Performance Analyzer will allow you to see and record logs that measure how each of your report elements performs.

Learn more about Performance Analyzer.

Note

Always remember to compare the embedded report performance to the performance on powerbi.com. This might help you understand the origin of your performance issues

Next steps