Who is this article for?

Administrators who want guidance on integrating Assurance with Microsoft Power BI.

Full user type with the super user role is required.

If you use Microsoft Power BI for your dashboard reporting, you can integrate with Assurance by following the steps below.

Need further assistance?
Our support team can only provide limited technical help for third party integrations such as Microsoft Power BI. If you require tailored solution advice, please contact our customer success team or Power BI support for assistance.

1. Setting up an Integration API Key

To set up an integration for your Assurance site, please contact our support team. Once the Integration addon has been switched on for your Assurance site, please complete the following steps.

1. Navigate to the Administration Setting in Assurance by selecting on the Gear Wheel.

2. Select on Integration under the General section.

3. Select on API Key.

Don't see the Integration or API Key button?
If you do not see the Integration or API Key button, please contact our support team.

4. Select on the blue Create API Key button.

5. Name your API Key and select on the blue Save button.

6. The API key will appear in the list. Select on the Name.

7. Copy the Key and then select Activate.

The API Key you have copied can now be used for setting up in Power BI. We suggest keeping this API Key in a safe place for future reference.

You will now need to set up the API report in Assurance to enable the integration in Power BI.

2. Setting up a UUID in a report to transfer data to Power BI

1. Open the report you would like to use and navigate to the Report Settings section.

2. Select on the tick box next to Available in API.

3. Save the report and it will then create a UUID, which will now appear under Available in API.

You now have all the information you need to complete setup in Power BI.

Data transfer not working?
Summary & Trend Chart must remain unticked in your report in Assurance for the data transfer to work.

4. Once you have set up your API Report, you can select the refresh schedule from a range of available options:

• Every day (at midnight)
• Every week (at midnight on Monday)
• Every month (at midnight on the first day of the month)

Don't see the Snapshot schedule?
The Snapshot schedule will only appear on reports that have been selected as Available in API.

3. Setting up an API connection in Power BI

1. Select on Get data from another source:

2. Then select Other > Web and select Connect:

3. The Web Data Connector form will then appear and should be completed as below:

1. Choose the Advanced option.

2. The URL parts should be in the format:

https://api.csassurance.com/api/v2/reports/{your-report-uuid}/snapshot.

For example, to set up a report with the UUID of 1234. The URL to be set up in Power BI would be:

https://api.csassurance.com/api/v2/reports/1234/snapshot.

3. Type to add the following HTTP request header parameters:

Please Note: Your Tenant Name is in your Assurance URL:

4. Type to add the relevant details for the HTTP request header parameters selected in Step 3.

5. Select OK.

On the next screen, make sure Anonymous is selected on the left-hand side, and that the level applied is the URL you put in on the previous screen. If not select on the drop-down arrow to select the correct one:

Select on Connect.

Once the data connection is created in Power BI, make sure to select on Close & Apply:

4. What to do if I am getting timeouts?

If you are getting timeouts, we would suggest:

1. Applying at least some filters to avoid the inclusion of unnecessary data and to speed up the process of generating a report. To learn more about applying field filters, please refer to our help article on How to Add Custom Fields to an Assurance Report.
2. Bringing in only those fields that would be useful in Power BI. As a best practice, we recommend removing unnecessary fields from the report being pulled into Power BI. This will keep your report free of unwanted fields, which can accumulate quickly and slow down your integration.
3. Checking what your network timeout is set to for Power BI (or whatever tool they’re using), bearing in mind that some reports can take several minutes to process before they’re available.
4. Adopting the version 2 of the API endpoint (Ensure 'v2' is used instead of 'v1' in the URL).
5. Adopting the snapshot version of the API endpoint, which is much faster and can be automated to refresh based on a schedule. Please refer to our help article on How to Automate API Reports in Assurance.