topic Re: Is there an API to get possible filter values (for buiding custom filter UI)? in Developer

Is there an API to get possible filter values (for buiding custom filter UI)?

Lumpie — Wed, 22 Jun 2022 14:04:53 GMT

We're using pbi embed to offer embedded reports in our custom solution. This works fine.

The next step is to offer a way to apply filters to these reports. I know it's possible to apply filters before loading or after loading a report (or visual). This works fine too if the filter is set up manually.

The challenge is to show the available values (options?) to the user to filter on.

For instance: let's say I want to offer a filter on product category (which is a column in a table in the underlying dataset). Is there a way to retrieve the possible product categories to present to the user? I've looked at all the API's but can't find anything that points me in the right direction. Or is it simply not available from the Power BI API's and would you have to build a connection to the actual data source yourself?

Since this functionality is available in Power BI itself I was hoping there's API's to get this data myself, too!

Mark

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

SpartaBI — Thu, 23 Jun 2022 14:36:58 GMT

Hi @Lumpie,

You can use this API to run a DAX query like "Evaluate Values(TableName[ColumnName])".
This will result in the distinct list of values from TableName[ColumnName], including a possible blank row due to broken referential integrity.
It is the same logic used by Power BI itself to populate slicers.

Note that if your tabular model is hosted on AAS/SSAS, you cannot use this API.
In this case, you can use the AMO-TOM assemblies to send the DAX query.
Those assemblies can be used to connect to any tabular model through its XMLA endpoint.

Showcase Report – Contoso By SpartaBI

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

Lumpie — Thu, 23 Jun 2022 14:42:07 GMT

That looks promising! I'll have a look at this.

Is there a way to get the available tables and/or columns this way as well? Or do you need to 'know' these beforehand?

Thanks for the help!

Mark

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

SpartaBI — Thu, 23 Jun 2022 15:38:37 GMT

Hi @Lumpie,

AMO-TOM gives you full access to the tabular object model, including the table names, column names & data types.
Alternatively, you can use AMO-TOM to query DMVs (e.g. select * from $SYSTEM.TMSCHEMA_TABLES).

In the Power BI APIs front, you can use the scanner APIs.
However, those are probably not suited for your use case (asynchronous, the metadata may not be up to date etc.).

Showcase Report – Contoso By SpartaBI

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

xhan — Thu, 30 Jun 2022 20:46:02 GMT

@Lumpie were you able to figure out how to get the avaiable tables and columns?

@SpartaBI can we get in a visual within a report, what are the tables and columns used in some rest APIs?

Thanks a lot!

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

SpartaBI — Fri, 01 Jul 2022 09:17:23 GMT

Hi @xhan,

You can get the available tables & columns using the AMO-TOM assemblies
Look at my reply from ‎06-23-2022 06:38 PM.

Using the Power BI embedded SDK, you can get the tables & columns defined in a visual. See here.

Showcase Report – Contoso By SpartaBI

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

xhan — Fri, 01 Jul 2022 22:51:14 GMT

Thank you @SpartaBI for the quick reply! I'm pretty new to power BI, and have some general questions.

1. Is AMO-TMO based on sql-server? we are not really using sql-server.

2.The embedded SKD looks like based on JS, I'm curious if there are something similar in the rest APIs?

3. I guess my previous question was not very clear. I'd like to pull all the metadata of the dashboards and reports. In a report, I'd like to know what are the pages, in each page what are the visuals, and what data source table and columns are used in the visuals etc. I was following this https://docs.microsoft.com/en-us/power-bi/admin/service-admin-metadata-scanning-setup to call the admin scanner APIs, but I don't see any table/column/measure data at all.

Thanks a lot!

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

SpartaBI — Sat, 02 Jul 2022 19:30:06 GMT

Hi @xhan,

1. Power BI uses "Analysis Services" as its analytical engine. AMO-TOM enables you to connect to an Analysis Services instance using its XMLA endpoint. If you are using Power BI Premium, you can allow access to the XMLA endpoint and use AMO-TOM. Analysis Services is also included as part of SQL Server (SSAS = SQL Server Analysis Services), but that should not concern you.

2. This functionality is not exposed as part of the documented Power BI REST APIs.

3. AFAIK, the scanner APIs do not return metadata at the page or visual granularity. If you set both tenant settings in the doc & performed a refresh, You should be able to get table/column/measure. See this doc regarding limitations.
This is an area in which Power BI lacks functionality. There are APIs to get some details for the pages & dashboards. See
get-pages-in-group
get-dashboards-in-group
get-tiles-in-group
You also have the option to get the structure directly from PBIX files by using 3-party (unsupported) tools like PBI Tools
Those parse the pages & visuals metadata. See, for example here (19:00).
If you need to export reports to PBIX files you can use
export-report-in-group

Showcase Report – Contoso By SpartaBI

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

xhan — Wed, 06 Jul 2022 19:15:57 GMT

thank you @SpartaBI

Re: Is there an API to get possible filter values (for buiding custom filter UI)?

SpartaBI — Wed, 06 Jul 2022 19:35:58 GMT

@xhan my pleasure.

Come follow us 🙂