Microsoft Purview Data Profiling API

Operations for data profiling operations

Operations 2

POST /dataquality/profiling/{assetId} Microsoft Purview Run data profiling #
GET /dataquality/profiling/{assetId} Microsoft Purview Get data profiling result #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/
📖
Authentication
https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/scanning
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/account
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/datamap
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/workflow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview
📖
Authentication
https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0
📖
Authentication
https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-information-protection-overview
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/developer/use-the-api
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-purview-data-profiling-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-purview-data-profiling-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Purview Data Quality Data Profiling API
  description: APIs for programmatically interacting with data quality rules, measuring data quality, and retrieving data quality scores for data assets. Supports data profiling, rule management, and quality assessment operations.
  version: 2024-03-01-preview
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://{accountName}.purview.azure.com
  description: Microsoft Purview Data Quality API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Data Profiling
  description: Operations for data profiling operations
paths:
  /dataquality/profiling/{assetId}:
    post:
      operationId: runDataProfiling
      summary: Microsoft Purview Run data profiling
      description: Initiate data profiling for a specific data asset.
      tags:
      - Data Profiling
      parameters:
      - name: assetId
        in: path
        required: true
        description: The data asset identifier
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfilingRequest'
      responses:
        '202':
          description: Data profiling initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfilingResult'
        '401':
          description: Unauthorized
    get:
      operationId: getDataProfilingResult
      summary: Microsoft Purview Get data profiling result
      description: Get data profiling results for a specific data asset.
      tags:
      - Data Profiling
      parameters:
      - name: assetId
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      responses:
        '200':
          description: Data profiling result retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfilingResult'
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  schemas:
    ProfilingResult:
      type: object
      properties:
        assetId:
          type: string
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
        profiledAt:
          type: string
          format: date-time
        rowCount:
          type: integer
          format: int64
        columnProfiles:
          type: array
          items:
            $ref: '#/components/schemas/ColumnProfile'
    ProfilingRequest:
      type: object
      properties:
        columns:
          type: array
          items:
            type: string
        sampleSize:
          type: integer
          format: int32
    ColumnProfile:
      type: object
      properties:
        columnName:
          type: string
        dataType:
          type: string
        nullCount:
          type: integer
          format: int64
        nullPercentage:
          type: number
          format: float
        distinctCount:
          type: integer
          format: int64
        minValue:
          type: string
        maxValue:
          type: string
        meanValue:
          type: string
        standardDeviation:
          type: number
          format: double
        topValues:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              count:
                type: integer
                format: int64
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://purview.azure.net/.default: Access Microsoft Purview