Articles in this section
Category / Section

How can I obtain the Iframe code using the Rest API?

Published:

In Iframe embedding, the dashboards can be embedded into a web application efficiently by automating the retrieval of Iframe embed codes. This can be achieved through the use of a REST API.

Retrieving Embed Code for On-Premise :

To obtain the Iframe embed code for an on-premise solution, you can use the following REST API endpoint:

https://{yourdomain}/bi/api/site/site1/v4.0/dashboards/{dashboardID}/embed-url

Please note that the {yourdomain} should be replaced with the actual Bold BI server URL. The <dashboardID> should be replaced with the actual ID of the dashboard you wish to embed.

Request Details

  • Request Type: GET

  • Header parameter: Authorization: bearer {your_access_token}

  • Path Parameter: Dashboard ID (replace {dashboardID} with the <guid> ID of the dashboard)

    image.png

Retrieving Embed Code for Cloud :

For cloud-based solutions, the REST API endpoint is slightly different:

https://{yourdomain}/bi/api/v4.0/dashboards/{dashboardID}/embed-url

Please note that the {yourdomain} should be replaced with the actual server Bold BI URL. The <dashboardID> should be replaced with the actual ID of the dashboard you wish to embed.

Request Details

  • Request Type: GET
  • Header parameter: Authorization: bearer {your_access_token}
  • Path Parameter: dashboardID (replace {dashboardID} with the <guid> ID of the dashboard)

References

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
SM
Written by Soundarya Mani Meharan
Updated
Comments (0)
Please  to leave a comment
Access denied
Access denied