Embedding Boards or Metrics

How to embed a board or metric card in other platforms

This guide outlines the steps for embedding a TargetBoard dashboard or KPI inside third-party platforms like BackStage, Tableau, or internal portals using a secure iFrame.

Embedding provides real-time visibility of TargetBoard data while maintaining full control over access and security.

Embedding requires an API key with appropriate permissions. Only users with administrative access can generate one.

1. Generate the Embed Code

To Embed a Full Board

To generate the embed code for a specific board:

• Open the relevant board in TargetBoard
• Click the Menu button (top-right corner)
• Select Embed

To Embed a single Metric

To generate the embed code for a specific Metric:

• Open the relevant board in TargetBoard
• Find the metric card you want to embed
• Click the Menu button (top-right corner of the card)
• Select Embed

In the Embed popup:

• Enter the host domain where the board or metric card will be embedded. (This is only if you want to protect the cross origin domain. If you're unsure, you can send it to us later to update on our end)
• Click Generate Code
• Copy the generated embed code

This code will include a placeholder like:
src="https://app.targetboard.ai/board/123?apiKey={API_KEY}"

You’ll replace {API_KEY} in the next step.

2. Create and Apply an API Key

To authenticate embedded access, an API key must be created with appropriate permissions.

Steps:

1. Go to Settings (bottom-left navigation)
2. Click API Keys
3. Click Create new API Key

In the creation popup:

• Enter a clear name for the key (e.g., BackStage Embed)
• Define an expiration date
• Choose the required permissions
• Click Create API Key

Copy the API key and replace the {API_KEY} value in your embed code with it:

src="https://app.targetboard.ai/board/123?apiKey=your_generated_key_here"

Your board is now ready to be embedded into external platforms.