Embedded API prerequisites

This list shows prerequisites for embedded APIs:

• Enable SSO for the space and generate the SSO password. See Setting Up Single Sign-On.
• Decide what SSO parameters you need. See SSO Parameters.
• Confirm the size of the dashboard to embed. This is also the size of the parent DIV container on the HTML page. Here are some considerations:
  • If you do not use the SSO parameter hideHeader=true then minimum width is 738px and the minimum height is 550px.
  • If you do use the SSO parameter hideHeader=true then there is no width and height limit and the end user can resize to any point.
  • If you use hideSubHeader=true, then the filter card and dashboard name are removed. This helps when embedding a single KPI or dashlet.

• The JavaScript embedding file is located at: https://birst_URL/js/birst_embed.js

Where birst_URL is the URL of the Birst server, for example, https://mrc.bws.birst.com/js/birst_embed.js