> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieves data products in a domain

> Retrieves the data products assigned to a domain, each with its catalog
description and documentation links, plus the documents filed under the domain.



## OpenAPI

````yaml get /api/dataproduct/by-domain
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/dataproduct/by-domain:
    get:
      tags:
        - Data products
      summary: Retrieves data products in a domain
      description: >-
        Retrieves the data products assigned to a domain, each with its catalog

        description and documentation links, plus the documents filed under the
        domain.
      operationId: get_dataproducts_by_domain_api_dataproduct_by_domain_get
      parameters:
        - name: domain_urn
          in: query
          required: true
          schema:
            type: string
            description: >-
              URN of the domain to list data products for, such as
              `urn:li:domain:finance`.
            title: Domain Urn
          description: >-
            URN of the domain to list data products for, such as
            `urn:li:domain:finance`.
        - name: query
          in: query
          required: false
          schema:
            type: string
            description: Free-text filter over the data products. Use `*` for all of them.
            default: '*'
            title: Query
          description: Free-text filter over the data products. Use `*` for all of them.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: Maximum number of data products to return.
            default: 50
            title: Limit
          description: Maximum number of data products to return.
        - name: docs_limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 0
            description: >-
              Maximum number of domain documents to return. Use `0` to skip
              them.
            default: 10
            title: Docs Limit
          description: Maximum number of domain documents to return. Use `0` to skip them.
      responses:
        '200':
          description: Retrieved data products successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProductsByDomainResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    DataProductsByDomainResponse:
      properties:
        domain_urn:
          type: string
          title: Domain Urn
          description: URN of the domain you queried.
        total:
          type: integer
          title: Total
          description: Total number of matching data products in the catalog.
          default: 0
        count:
          type: integer
          title: Count
          description: Number of data products in this response.
          default: 0
        dataproducts:
          items:
            $ref: '#/components/schemas/DataProductSummary'
          type: array
          title: Dataproducts
          description: Data products in the domain, each with its description and docs.
        domain_docs:
          items:
            $ref: '#/components/schemas/DataProductDoc'
          type: array
          title: Domain Docs
          description: >-
            DataHub documents filed under the domain. Documents attach to a
            domain rather than to an individual data product, so they apply to
            every product listed here.
      type: object
      required:
        - domain_urn
      title: DataProductsByDomainResponse
      description: Data products in a domain, together with the domain's documents.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DataProductSummary:
      properties:
        urn:
          type: string
          title: Urn
          description: URN of the data product.
        id:
          type: string
          title: Id
          description: ID of the data product, the last segment of the URN.
          default: ''
        name:
          type: string
          title: Name
          description: Display name of the data product.
          default: ''
        description:
          type: string
          title: Description
          description: Description of the data product from the catalog.
          default: ''
        external_url:
          type: string
          title: External Url
          description: External URL registered for the data product.
          default: ''
        asset_count:
          type: integer
          title: Asset Count
          description: Number of assets linked to the data product.
          default: 0
        domain:
          $ref: '#/components/schemas/DataProductDomainRef'
          description: Domain that owns the data product.
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: Tags attached to the data product.
        glossary_terms:
          items:
            type: string
          type: array
          title: Glossary Terms
          description: Glossary terms attached to the data product.
        owners:
          items:
            type: string
          type: array
          title: Owners
          description: Owners of the data product.
        docs:
          items:
            $ref: '#/components/schemas/DataProductDoc'
          type: array
          title: Docs
          description: Documentation links attached to the data product.
      type: object
      required:
        - urn
      title: DataProductSummary
      description: A DataHub data product with its catalog metadata.
    DataProductDoc:
      properties:
        type:
          type: string
          title: Type
          description: 'Kind of documentation: `link` or `document`.'
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: Target URL. Set for `link` docs only.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the documentation link.
        urn:
          anyOf:
            - type: string
            - type: 'null'
          title: Urn
          description: DataHub URN. Set for `document` docs only.
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: Title of the document.
        subtype:
          anyOf:
            - type: string
            - type: 'null'
          title: Subtype
          description: DataHub document subtype, such as `Runbook` or `FAQ`.
        snippet:
          anyOf:
            - type: string
            - type: 'null'
          title: Snippet
          description: First 500 characters of the document body.
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: Tags attached to the document.
        glossary_terms:
          items:
            type: string
          type: array
          title: Glossary Terms
          description: Glossary terms attached to the document.
      type: object
      required:
        - type
      title: DataProductDoc
      description: >-
        A piece of documentation attached to a data product.


        Two kinds share this shape, discriminated by `type`: a `link` is a

        documentation link from the product's DataHub institutional memory, and
        a

        `document` is a DataHub document entity, where `url` is unset and
        `snippet`

        holds the first 500 characters of the body.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    DataProductDomainRef:
      properties:
        urn:
          type: string
          title: Urn
          description: URN of the domain.
          default: ''
        name:
          type: string
          title: Name
          description: Display name of the domain.
          default: ''
      type: object
      title: DataProductDomainRef
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.