As a workspace manager, you will have the ability to connect with Microsoft PowerBI using your own API key.
When connecting with an external software, Matidor authenticates against an API key of a specific user to determine what information is accessible. Similar to your password, the API key is secretive and should be kept safe and reset on a regular basis.
At this moment, only Workspace Managers can generate API keys.
Step 1: Create an API Key
In Matidor, go to Settings -> Personal settings
Under the "User Preferences" section, you can click on the + sign to create an API Key.
The API Key will be shown only once, where you can copy it and store in a safe place. The next time when you open the Personal settings again, the key will be masked.
If you forget the key, or anytime you need to reset it, just delete the existing key and generate a new key again.
Step 2: Connect with Microsoft PowerBI
Next, we will use the API key to connect Matidor with Microsoft PowerBI.
Open MS PowerBI desktop.
Under Files -> Get Data, select "Web":
A dialog will pop up. Select "Advance".
In the "URL parts" enter ONE of the following URLs provided by Matidor:
To retrieve all projects:
https://core.matidor.com/api/public/v1/bi/all-projects/projects
Or, to retrieve projects of a template:
https://core.matidor.com/api/public/v1/bi/all-projects/projects?template=<template key>
To retrieve all work: (Pagination 1000+ records)
https://core.matidor.com/api/public/v2/bi/all-projects/work
Or, to retrieve work of a template:
https://core.matidor.com/api/public/v1/bi/all-projects/work?template=<template key>
To retrieve all budgets:
https://core.matidor.com/api/public/v1/bi/all-projects/budgets
To retrieve all costs:
https://core.matidor.com/api/public/v1/bi/all-projects/costs
In the "HTTP request header parameters" enter
Authorization
Bearer <YOUR_API_KEY>
IMPORTANT:
Replace <YOUR_API_KEY> with your own API key from Step 1 above.
Make sure to include "Bearer " before your API key.
When done, click OK. It may take up to several minutes to retrieve the data depending on the size.
If a second dialog box pops up asking about the permission scope, just click Connect.
From this point on, you can use Microsoft PowerBI to create various live Matidor reports.
Extra: Configuring Power BI to retrieve all records for URL(s) with pagination
If you already have an existing Power BI report connected to the Matidor BI API, two changes are required.
Change 1 – Update the Source Step to Handle Pagination
Open your query in Power Query Editor:
Open Power BI Desktop.
Select Transform Data.
Select your Matidor query.
Click Advanced Editor.
Replace the existing Source step with the updated paginated version provided by Matidor.
Replace only that line with this:
let
Source =
let
Token = "YOUR_TOKEN_HERE",
GetPage = (Url as text) =>
Json.Document(
Web.Contents(
Url,
[
Headers = [
Authorization = "Bearer " & Token
]
]
)
),
FirstPage =
GetPage(
),
Pages =
List.Generate(
() => FirstPage,
each _ <> null,
each
if Record.HasFields(_, "@odata.nextLink") then
GetPage(Record.Field(_, "@odata.nextLink"))
else
null
),
Combined =
[
value =
List.Combine(
List.Transform(
Pages,
each [value]
)
)
]
in
Combined,
Change 2 – Remove the @odata.nextLink Column Type
After pagination is implemented, the @odata.nextLink field is only used internally to retrieve additional pages. It is not included in the final dataset.
If your query still attempts to change the type of this column, Power BI will display the following error:
Expression.Error: The column '@odata.nextLink' of the table wasn't found.
How to fix
Locate the Changed Type step in the query.
Remove the following line from the list of column type definitions:
, {"@odata.nextLink", type text}No other changes to the Changed Type step are required.
