How to fetch the record count of classifications using purview API ?

Question

How to fetch the record count of classifications using purview API ?

Dhanoordaran V 170

Let's say the data asset "A" is having the classification as "All full names". similarly, we have x number of data assets across Y number of data sources classified as "All full name".

Q1) In this case how can I fetch the detail "total number of records classified as "All full name" across all data sources and data assets within them.

Q2) I may need to send this information to external reporting systems (such as PowerBi) where I can filter the record count based on "Data sources" or "data assets" for all the system & custom classifications.

Kindly explain in detail how to address these using Purview's API capabilities

Accepted answer

0 additional answers

Your answer

Answer 1

Smaran Thoomu 23,260 Microsoft External Staff Moderator

Hi @Dhanoordaran V

Microsoft Purview provides REST APIs that allow you to query classification metadata across your data estate. However, it’s important to clarify that Purview does not track actual “record counts” of classified data (e.g., number of rows labeled as “All full names”) at the row level. It works at the metadata level, i.e., identifying which columns or assets are classified with specific labels.

How to get the total number of assets/columns classified as “All full name”

You can use the Scan Results / Classifications API to list assets or columns that have a specific classification applied.

Steps:

Use the Purview Search API to find all assets with the classification "All full names":

POST https://<your-purview-account-name>.purview.azure.com/catalog/api/search/query?api-version=2023-09-01-preview

Sample Payload:

{
  "keywords": null,
  "limit": 100,
  "filter": {
    "classification": ["All full names"]
  } 
}

Count the number of results returned (you can paginate using the offset parameter).
Optionally, filter by asset type or data source in the request body.

Exporting this to Power BI with filters by asset or data source

There’s no direct connector yet, but you can follow this workaround:

Option 1: Azure Function / Logic App

Create an Azure Function or Logic App that calls the Purview Search API regularly.
Parse and structure the results (e.g., asset name, data source, classification).
Store the results in a staging location (Azure SQL, Blob Storage, or Data Lake).
Connect Power BI to that storage for reporting and filtering.

Option 2: Azure Data Factory (ADF)

ADF Web Activity can call the Purview API and capture results.
Store and transform that data into a Power BI-friendly format.

You’ll need to register an Azure AD app, grant it Purview Data Curator or Reader role, and authenticate using OAuth2 when calling the API.

Reference: https://learn.microsoft.com/en-us/rest/api/purview/

I hope this information helps. Please do let us know if you have any further queries.

Kindly consider upvoting the comment if the information provided is helpful. This can assist other community members in resolving similar issues.

Dhanoordaran V 170 Reputation points

2025-04-17T12:34:12.9566667+00:00

Thanks @Smaran Thoomu for the reply.
Dhanoordaran V 170 Reputation points

2025-04-17T12:48:50.8333333+00:00

@Smaran Thoomu a follow up doubt related to Purview API, can we apply tagging of data estate using API calls based on some custom conditions.

Example: If source of the file is "x" application tag it as "x" . like that.

Please explain
Smaran Thoomu 23,260 Reputation points Microsoft External Staff Moderator

2025-04-17T13:05:21.8533333+00:00
@Dhanoordaran V Yes, Microsoft Purview REST APIs do support programmatic tagging (classifying or updating metadata) of assets based on your custom conditions, like tagging based on source system, file type, or naming patterns.> How to Tag Assets Using Purview API Based on Custom Conditions

You can follow this general approach:

Search or Scan for Assets Based on Your Condition: Use the Search API or filter scan results to identify assets with metadata like:

File source (e.g., path contains “/x/”)

Asset name, type, schema, etc.

{ "keywords": null, "limit": 100, "filter": { "attributeName": "qualifiedName", "operator": "contains", "value": "/x/" } }

Use the Classification/Tagging API: Once you’ve filtered the assets, you can apply a tag using the Add Classification API.

API Endpoint:

POST https://<your-purview-account>.purview.azure.com/catalog/api/atlas/v2/entity/bulk/classification

Payload Example:

{ "classification": { "typeName": "x_source_tag" }, "entityGuids": [ "guid1", "guid2" ] }

typeName: The name of the classification (tag) you want to apply (must already exist in Purview).

entityGuids: List of entity GUIDs to which the tag should be applied.

To automate conditional tagging:

Azure Functions or Logic Apps can run on a schedule

Query the Purview API

Apply custom logic in code (e.g., "if qualifiedName contains /x/, apply 'X_Source' tag")

Call the classification API to apply tags

You can even integrate with Azure Data Factory via Web Activities.

Ensure that the app or identity making the API call has:

Purview Data Curator role (for tagging)

Proper OAuth2 token setup

Hope this helps. Do let us know if you any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
Dhanoordaran V 170 Reputation points

2025-04-17T13:12:29.8666667+00:00

Thanks a lot @Smaran Thoomu

Share via

How to fetch the record count of classifications using purview API ?

0 additional answers

Your answer