Microsoft Purview Search API

The Search API from Microsoft Purview — 3 operation(s) for search.

GitHub OpenAPI

Operations 3

POST /search/autocomplete Discovery auto complete #
POST /search/query Discovery query #
POST /search/suggest Discovery suggest #

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
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
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

Schemas & Data

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:microsoft-purview-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Azure Analytics Purview Data Map Search API
  version: '2023-09-01'
  description: 'Purview Data Map Service is a fully managed cloud service whose users can

    discover the data sources they need and understand the data sources they find.

    At the same time, Data Map helps organizations get more value from their

    existing investments. This spec defines REST API of Purview Data Map Service.'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://purview.azure.net/.default
tags:
- name: Search
paths:
  /search/autocomplete:
    post:
      operationId: Discovery_AutoComplete
      description: Get auto complete options.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoCompleteResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoCompleteOptions'
        description: Body parameter.
        required: true
      tags:
      - Search
      summary: Discovery auto complete
      x-summary-source: derived
  /search/query:
    post:
      operationId: Discovery_Query
      description: Get data using search.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryOptions'
        description: Body parameter.
        required: true
      tags:
      - Search
      summary: Discovery query
      x-summary-source: derived
  /search/suggest:
    post:
      operationId: Discovery_Suggest
      description: Get search suggestions by query criteria.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestOptions'
        description: Body parameter.
        required: true
      tags:
      - Search
      summary: Discovery suggest
      x-summary-source: derived
components:
  schemas:
    QueryOptions:
      type: object
      description: The search query of advanced search request.
      properties:
        keywords:
          type: string
          description: The keywords applied to all searchable fields.
        limit:
          type: integer
          format: int32
          description: 'The limit of the number of the search result. default value is 50; maximum

            value is 1000.'
        continuationToken:
          type: string
          description: 'The token used to get next batch of data. Default ''Null'' to get the first

            batch, and will return new token in each response unless there''s no more data.'
        orderby:
          type: array
          description: The sort order of search results, can specify multiple fields.
          items: {}
        filter:
          description: The filter for the search. See examples for the usage of supported filters.
        facets:
          type: array
          description: The facets for search. See examples for the usage of supported facets.
          items:
            $ref: '#/components/schemas/SearchFacetItem'
        taxonomySetting:
          $ref: '#/components/schemas/SearchTaxonomySetting'
          description: The taxonomy setting for search.
    AutoCompleteOptions:
      type: object
      description: The payload of autocomplete request.
      properties:
        keywords:
          type: string
          description: 'The keywords applied to all fields that support autocomplete operation. It must

            be at least 1 character, and no more than 100 characters.'
        limit:
          type: integer
          format: int32
          description: 'The number of autocomplete results we hope to return. The default value is 50.

            The value must be a number between 1 and 100.'
        filter:
          description: The filter for the autocomplete request.
    SuggestResult:
      type: object
      description: The result item of the search suggest.
      properties:
        value:
          type: array
          description: The result value
          items:
            $ref: '#/components/schemas/SuggestResultValue'
    SuggestResultValue:
      type: object
      description: The value item of the search suggest.
      properties:
        '@search.score':
          type: number
          format: float
          description: 'The search score calculated by the search engine. The results are ordered by

            search score by default.'
          x-ms-client-name: searchScore
        '@search.text':
          type: string
          description: 'The target text that contains the keyword as prefix. The keyword is wrapped

            with emphasis mark.'
          x-ms-client-name: searchText
        objectType:
          type: string
          description: 'The object type of the record. Object type is the top-level property to

            distinguish whether a record is an asset or a term.'
        createTime:
          type: integer
          format: int64
          description: The create time of the record. The Unix epoch format.
        updateTime:
          type: integer
          format: int64
          description: The last update time of the record. The Unix epoch format.
        id:
          type: string
          description: The GUID of the record.
        name:
          type: string
          description: The name of the record.
        qualifiedName:
          type: string
          description: The qualified name of the record.
        entityType:
          type: string
          description: The type name of the asset.
        description:
          type: string
          description: The description of the asset.
        endorsement:
          type: array
          description: The endorsement of the asset.
          items:
            type: string
        owner:
          type: string
          description: The owner of the record.
        classification:
          type: array
          description: The classifications of the record.
          items:
            type: string
        label:
          type: array
          description: The labels of the asset.
          items:
            type: string
        term:
          type: array
          description: The terms assigned to the asset.
          items:
            $ref: '#/components/schemas/TermSearchResultValue'
        contact:
          type: array
          description: The contacts of the asset.
          items:
            $ref: '#/components/schemas/ContactSearchResultValue'
        assetType:
          type: array
          description: The asset types of the asset.
          items:
            type: string
        glossaryType:
          type: string
          description: 'The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or

            AtlasGlossaryCategory.'
        glossary:
          type: string
          description: The glossary name of the term.
        termStatus:
          type: string
          description: The status of the term.
        termTemplate:
          type: array
          description: The term template names used by the term.
          items:
            type: string
        longDescription:
          type: string
          description: The definition of the term.
    AtlasErrorResponse:
      type: object
      description: An error response from the service
      properties:
        requestId:
          $ref: '#/components/schemas/Azure.Core.uuid'
          description: The request ID.
        errorCode:
          type: string
          description: The error code.
        errorMessage:
          type: string
          description: The error message.
    SearchResultValue:
      type: object
      description: The value item of the search result.
      properties:
        '@search.score':
          type: number
          format: float
          description: 'The search score calculated by the search engine. The results are ordered by

            search score by default.'
          x-ms-client-name: searchScore
        '@search.highlights':
          $ref: '#/components/schemas/SearchHighlights'
          description: 'A highlight list that consists of index fields id ,qualifiedName, name,

            description, entityType. When the keyword appears in those fields, the value of

            the field, attached with emphasis mark, is returned as an element of

            @search.highlights.'
          x-ms-client-name: searchHighlights
        objectType:
          type: string
          description: 'The object type of the record. Object type is the top-level property to

            distinguish whether a record is an asset or a term.'
        createTime:
          type: integer
          format: int64
          description: The create time of the record. The Unix epoch format.
        updateTime:
          type: integer
          format: int64
          description: The last update time of the record. The Unix epoch format.
        id:
          type: string
          description: The GUID of the record.
        name:
          type: string
          description: The name of the record.
        qualifiedName:
          type: string
          description: The qualified name of the record.
        entityType:
          type: string
          description: The type name of the asset.
        description:
          type: string
          description: The description of the asset.
        endorsement:
          type: array
          description: The endorsement of the asset.
          items:
            type: string
        owner:
          type: string
          description: The owner of the record.
        classification:
          type: array
          description: The classifications of the record.
          items:
            type: string
        label:
          type: array
          description: The labels of the asset.
          items:
            type: string
        term:
          type: array
          description: The terms assigned to the asset.
          items:
            $ref: '#/components/schemas/TermSearchResultValue'
        contact:
          type: array
          description: The contacts of the asset.
          items:
            $ref: '#/components/schemas/ContactSearchResultValue'
        assetType:
          type: array
          description: The asset types of the asset.
          items:
            type: string
        glossaryType:
          type: string
          description: 'The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or

            AtlasGlossaryCategory.'
        glossary:
          type: string
          description: The glossary name of the term.
        termStatus:
          type: string
          description: The status of the term.
        termTemplate:
          type: array
          description: The term template names used by the term.
          items:
            type: string
        longDescription:
          type: string
          description: The definition of the term.
    ContactSearchResultValue:
      type: object
      description: The contact in the search and suggest result.
      properties:
        id:
          type: string
          description: The GUID of the contact.
        info:
          type: string
          description: The description of the contact.
        contactType:
          type: string
          description: 'The type of the contact. It can be Expert or Owner for an entity. It can be

            Expert or Steward for a glossary term.'
    SearchTaxonomySetting:
      type: object
      description: Taxonomy setting for search request
      properties:
        assetTypes:
          type: array
          description: Asset types
          items:
            type: string
        facet:
          $ref: '#/components/schemas/SearchFacetItem'
          description: The content of a search facet result item.
    SearchSortOrder:
      type: string
      description: Search sort order
      enum:
      - asc
      - desc
      x-ms-enum:
        name: SearchSortOrder
        modelAsString: true
        values:
        - name: Ascend
          value: asc
          description: Use ascending order for sorting
        - name: Descend
          value: desc
          description: Use descending order for sorting
    Azure.Core.uuid:
      type: string
      format: uuid
      description: Universally Unique Identifier
    SuggestOptions:
      type: object
      description: The payload of suggest request.
      properties:
        keywords:
          type: string
          description: 'The keywords applied to all fields that support suggest operation. It must be

            at least 1 character, and no more than 100 characters. In the index schema we

            defined a default suggester which lists all the supported fields and specifies

            a search mode.'
        limit:
          type: integer
          format: int32
          description: 'The number of suggestions we hope to return. The default value is 5. The value

            must be a number between 1 and 100.'
        filter:
          description: The filter for the search.
    SearchFacetItemValue:
      type: object
      description: The content of a search facet result item.
      properties:
        count:
          type: integer
          format: int32
          description: The count of the facet item.
        value:
          type: string
          description: The name of the facet item.
    SearchFacetItem:
      type: object
      description: The content of a search facet result item.
      properties:
        count:
          type: integer
          format: int32
          description: The count of the facet item.
        facet:
          type: string
          description: The name of the facet item.
        sort:
          $ref: '#/components/schemas/SearchFacetSort'
          description: Define the sorting criteria for items
    AutoCompleteResult:
      type: object
      description: The result of the autocomplete request.
      properties:
        value:
          type: array
          description: The result value
          items:
            $ref: '#/components/schemas/AutoCompleteResultValue'
    QueryResult:
      type: object
      description: The result of the search result.
      properties:
        '@search.count':
          type: integer
          format: int32
          description: 'The total number of search results (not the number of documents in a single

            page).'
          x-ms-client-name: searchCount
        '@search.count.approximate':
          type: boolean
          description: '''True'' if the ''@search.count'' is an approximate value and vise versa.'
          x-ms-client-name: searchCountApproximate
        continuationToken:
          type: string
          description: The token used to get next batch of data. Absent if there's no more data.
        '@search.facets':
          $ref: '#/components/schemas/SearchFacetResultValue'
          description: 'A facet list that consists of index fields assetType ,classification,

            contactId, and label. When the facet is specified in the request, the value of

            the facet is returned as an element of @search.facets.'
          x-ms-client-name: searchFacets
        value:
          type: array
          description: Search result value
          items:
            $ref: '#/components/schemas/SearchResultValue'
    TermSearchResultValue:
      type: object
      description: The context.
      properties:
        name:
          type: string
          description: The name of the term.
        glossaryName:
          type: string
          description: The name of the glossary which contains the term.
        guid:
          type: string
          description: The GUID of the term.
    SearchFacetSort:
      type: object
      description: The sorting criteria
      properties:
        count:
          $ref: '#/components/schemas/SearchSortOrder'
          description: Order by count
        value:
          $ref: '#/components/schemas/SearchSortOrder'
          description: Order by value
    SearchFacetResultValue:
      type: object
      description: 'A facet list that consists of index fields assetType ,classification,

        contactId, and label. When the facet is specified in the request, the value of

        the facet is returned as an element of @search.facets.'
      properties:
        entityType:
          type: array
          description: Entity type
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        assetType:
          type: array
          description: Asset type
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        classification:
          type: array
          description: Classification
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        term:
          type: array
          description: Term
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        contactId:
          type: array
          description: Contact id
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        contactType:
          type: array
          description: Contact type
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        label:
          type: array
          description: Label
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        glossaryType:
          type: array
          description: Glossary type
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        termStatus:
          type: array
          description: Term status
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
        termTemplate:
          type: array
          description: Term template
          items:
            $ref: '#/components/schemas/SearchFacetItemValue'
    SearchHighlights:
      type: object
      description: 'A highlight list that consists of index fields id ,qualifiedName, name,

        description, entityType. When the keyword appears in those fields, the value of

        the field, attached with emphasis mark, is returned as an element of

        @search.highlights.'
      properties:
        id:
          type: array
          description: Id
          items:
            type: string
        qualifiedName:
          type: array
          description: Qualified name
          items:
            type: string
        name:
          type: array
          description: Name
          items:
            type: string
        description:
          type: array
          description: Description
          items:
            type: string
        entityType:
          type: array
          description: Entity type
          items:
            type: string
    AutoCompleteResultValue:
      type: object
      description: The value item of the autocomplete suggest.
      properties:
        text:
          type: string
          description: The completed term or phrase.
        queryPlusText:
          type: string
          description: The completed search query text.
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://purview.azure.net/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/datamap/api'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true