Use the Power BI correlation ID

  • Article

With the Power BI embedded correlation ID, you can correlate your application session ID with the Power BI embedded session ID. Supplying the session ID to Power BI support helps with retrieving additional debugging information.

You can call the getCorrelationId function from any embedded Power BI items, including reports and dashboards.

The getCorrelationId API lets you get the current Power BI embedded correlation ID.

How to get the Power BI correlation ID

The getCorrelationId function shown in the following code sample returns the embedded correlation ID.

getCorrelationId(): Promise<string>

Example

let correlationId = await report.getCorrelationId();

This example shows how to get the correlation ID when an error occurs.

dashboard.on("error", function (error) {
    let correlationId = await dashboard.getcorrelationId();
    console.log("Error occurred in embed session: " + correlationId + " Error: " + error.detail.message);
});

Limitations

The getCorrelationId function only works after the report is loaded.

Next steps

How to handle events

Override default error messages