---
title: "Power BI Integration"
slug: "power-bi-integration"
updated: 2024-04-08T17:52:39Z
published: 2024-04-08T17:52:39Z
canonical: "docs.catchpoint.com/power-bi-integration"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catchpoint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Power BI Integration

## **Introduction**

Power BI is a business analytics service by Microsoft. It aims to provide interactive visualizations and business intelligence capabilities with an interface simple enough for end-users to create their own reports and dashboards.

This integration enables you to push performance and alert data from Catchpoint to Power BI the moment its recorded. It relies on Catchpoint's two push APIs, **Test Data Webhook** and **Alert Webhook**. The Test Data Webhook API pushes all test performance metrics immediately after each test run. The Alert Webhook API pushes alert data the moment an alert is triggered. The data is sent via real-time streaming in Power BI, and we will be using the "push dataset" method. When the dataset is created, the Power BI service automatically creates a new database in the service to store the data. You can then generate reports based on the stored data.

## **Prerequisites**

1. Power BI account.
2. Power BI desktop app. (To import reports)

## **Installation and Configuration**

#### **Power BI setup:**

1. In the **[Power BI](https://app.powerbi.com/)** service, select a **workspace** and select **New**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725511-step1.png)
2. Select **Streaming dataset** and choose **API** as the source of your data and click **Next**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725531-step2a.png)  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725551-step2b.png)
3. In the **Name** field, enter a name for the **Dataset**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095775652-step3.png)
4. For **Values**, add the value name and value type as shown below.

**For Test Data webhook:**

| Value Name | Value Type |
| --- | --- |
| Client Time | Number |
| TCP Connect Time | Number |
| Content Load Time | Number |
| DNS Resolution Time | Number |
| Document Complete Time | Number |
| DOM Content Load Time | Number |
| DOM Interactive Time | Number |
| DOM Load Time | Number |
| First Party Zone Impact | Number |
| Third Party Zone Impact | Number |
| Load Time | Number |
| Total Root Request Redirect Time | Number |
| Render Start Time | Number |
| Total Root Request Time | Number |
| Send Time | Number |
| TLS/SSL Time | Number |
| Time to Title | Number |
| Total Test Time | Number |
| Wait Time | Number |
| Webpage Response Time | Number |
| Wire Time | Number |
| Timestamp | DateTime |
| Test Name | Text |
| Node Name | Text |
| Error | Text |
| isError | Number |
| All other macros from the [TEST DATA WEBHOOK MACROS](https://docs.catchpoint.com/docs/test-data-webhook-macros) article are also supported. |  |

**For Alert Webhook**:

| Value Name | Value Type |
| --- | --- |
| event_type | Text |
| description | Text |
| Test Name | Text |
| Test Id | Text |
| Test Url | Text |
| NodeName | Text |
| NodeClientAddress | Text |
| Timestamp | DateTime |
| Trigger Timestamp | DateTime |
| All other macros from the [ALERT WEBHOOK MACRO](https://support.catchpoint.com/hc/en-us/articles/210003423) article are also supported. |  |

1. Enable **Historical data analysis**.
2. Click **Create**. Capture the **Push URL** which will be needed during the Catchpoint setup.  

![step3b.png](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725571-step3b.png)

#### **Catchpoint Setup:**

To get Catchpoint Test data into Power BI, log in into the Catchpoint Portal and go to **Settings > API.**

1. In the **Test Data Webhook** and **Alert Webhook** sections, add the copied **Push URL**.  

(Perform all of the following steps in both sections)
2. Set status to **Active**.
3. Select **Template**.
4. Click **Add New** from the drop-down.
5. Enter a **Name**.
6. Select **JSON** under format.
7. Paste template content from the attached `.txt` files. (`Testdata-Webhook-Template.txt` for Test Data Webhook and `Alert-Webhook-Template.txt` for Alert Webhook.)
8. Click **Save**.

**Note:** For each test that you want to send data to Power BI, you must enable the **Test Data Webhook** option under **Test Properties > More Settings**.

## **Implementation**

**Importing Reports:**

1. In Power BI Desktop, in the navigator pane, click **Open report** and select **Browse reports**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725331-desktop_1.png)
2. Select the attached **.PBIX** extension file.
3. A warning message will pop up showing “**Unable to connect**”. Select **Edit**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725371-desktop_3.png)
4. Select a **dataset** that was created in the previous steps.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725411-desktop_5.png)

## **Result**

The **Catchpoint - Overview** dashboard is your central location for the Catchpoint tests in Power BI, and includes widgets that display recent Alerts and Catchpoint test data. ![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095872812-overview.png)

The **Alerts** page allows you to view the history of all the alerts reported by Catchpoint. ![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095729531-Alerts.png)

**To create your own visualization or reports.**

1. In your **[Power BI](https://app.powerbi.com/)** workspace, select **New** and choose **Report**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095775632-reports-1.png)
2. Select **Pick a published dataset** and choose the created dataset.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725471-report-2.png)
3. This should create an empty report. You can choose different visualizations fields to customize the report.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360095725491-report-3.png)

Note: This article: [https://docs.microsoft.com/en-us/power-bi/create-reports/service-dashboard-pin-tile-from-report](https://docs.microsoft.com/en-us/power-bi/create-reports/service-dashboard-pin-tile-from-report) explains how to pin a tile to a Power BI dashboard from a report.

[Alert-Webhook-Template.txt](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/Alert-Webhook-Template.txt)

[Catchpoint-Alerts.xml](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/Catchpoint-Alerts.xml)

[Catchpoint-Overview.xml](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/Catchpoint-Overview.xml)

[Testdata-Webhook-Template.txt](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/Testdata-Webhook-Template.txt)
