Merged PR 82436: [Embed JS] Add getCorrelationId

Add support for users to be able to get the correlation id [AKA session ID] for their embed session

Author: liavZayde

dist/powerbi-client.d.ts

@@ -338,6 +338,20 @@ declare module "embed" {
          * @returns {Promise<void>}
          */
         saveAs(saveAsParameters: models.ISaveAsParameters): Promise<void>;
+        /**
+         * Get the correlationId for the current embed session.
+         *
+         * ```javascript
+         * // Get the correlationId for the current embed session
+         * report.getCorrelationId()
+         *   .then(correlationId => {
+         *     ...
+         *   });
+         * ```
+         *
+         * @returns {Promise<string>}
+         */
+        getCorrelationId(): Promise<string>;
         /**
          * Sends load configuration data.
          *

dist/powerbi.js

@@ -312,6 +312,27 @@ export abstract class Embed {
       });
   }
 
+  /**
+   * Get the correlationId for the current embed session.
+   *
+   * ```javascript
+   * // Get the correlationId for the current embed session
+   * report.getCorrelationId()
+   *   .then(correlationId => {
+   *     ...
+   *   });
+   * ```
+   *
+   * @returns {Promise<string>}
+   */
+  getCorrelationId(): Promise<string> {
+    return this.service.hpm.get<string>(`/getCorrelationId`, { uid: this.config.uniqueId }, this.iframe.contentWindow)
+      .then(response => response.body,
+      response => {
+        throw response.body;
+      });
+  }
+
   /**
    * Sends load configuration data.
    *