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

# Domain

> Domain endpoints: Create Domain, Get Export Data, Get Domain, Get Domains, Get Domains Tree List, Update Domain, Delete Domain

<script type="application/ld+json">
  {`{
            "@context": "https://schema.org",
            "@type": "TechArticle",
            "headline": "Domain",
            "description": "Domain endpoints: Create Domain, Get Export Data, Get Domain, Get Domains, Get Domains Tree List, Update Domain, Delete Domain",
            "url": "https://docs.dqlabs.ai/api-reference/governance/domain",
            "publisher": {
              "@type": "Organization",
              "name": "DQLabs Inc",
              "logo": "https://media.brand.dev/332adc35-5bc4-4d2b-bf78-256aa4a5e414.svg"
            }
            }`}
</script>

<Tabs>
  <Tab title="Create Domain">
    `POST /api/v1/governance/domain`

    Create a new domain

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">The endpoint's response payload.</ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>" \
        -H "Content-Type: application/json" \
        -d '{}'
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Create a new domain",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {}
    }
    ```
  </Tab>

  <Tab title="Get Export Data">
    `POST /api/v1/governance/domain/export`

    Get Export Data

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">The endpoint's response payload.</ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/export" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>" \
        -H "Content-Type: application/json" \
        -d '{}'
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Get Export Data",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {}
    }
    ```
  </Tab>

  <Tab title="Get Domain">
    `GET /api/v1/governance/domain/{domainId}`

    Get a domain by ID

    **Path Parameters**

    <ParamField path="domainId" type="string" required={true}>
      Example: \`\`
    </ParamField>

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">
      <ResponseField name="name" type="string">
        Example: `"Domain Test 7"`.
      </ResponseField>

      <ResponseField name="description" type="string">
        Example: `"Domain Test 7 represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology."`.
      </ResponseField>

      <ResponseField name="type" type="string">
        Example: `"domain"`.
      </ResponseField>

      <ResponseField name="level" type="integer">
        Example: `1`.
      </ResponseField>

      <ResponseField name="source" type="string" />

      <ResponseField name="parent_id" type="string" />

      <ResponseField name="owner_team" type="string" />

      <ResponseField name="qualified_name" type="string">
        Example: `"Domain Test 7"`.
      </ResponseField>

      <ResponseField name="score" type="string" />

      <ResponseField name="total_alerts" type="integer">
        Example: `0`.
      </ResponseField>

      <ResponseField name="total_issues" type="integer">
        Example: `0`.
      </ResponseField>

      <ResponseField name="linked_asset_count" type="integer">
        Example: `0`.
      </ResponseField>

      <ResponseField name="linked_metric_count" type="integer">
        Example: `0`.
      </ResponseField>

      <ResponseField name="total_likes" type="string" />

      <ResponseField name="total_dislikes" type="string" />

      <ResponseField name="total_conversations" type="integer">
        Example: `0`.
      </ResponseField>

      <ResponseField name="total_views" type="integer">
        Example: `4`.
      </ResponseField>

      <ResponseField name="status" type="string">
        Example: `"VERIFIED"`.
      </ResponseField>

      <ResponseField name="is_active" type="boolean">
        Example: `true`.
      </ResponseField>

      <ResponseField name="is_deleted" type="boolean">
        Example: `false`.
      </ResponseField>

      <ResponseField name="owner" type="object[]">
        <ResponseField name="id" type="string">
          Example: `"f78830aa-4fb0-448f-b36f-34aa318d1c35"`.
        </ResponseField>

        <ResponseField name="name" type="string">
          Example: `"data quality"`.
        </ResponseField>

        <ResponseField name="email" type="string">
          Example: `"data_quality@dqlabs.ai"`.
        </ResponseField>

        <ResponseField name="label" type="string">
          Example: `"data quality"`.
        </ResponseField>

        <ResponseField name="owner_type" type="string">
          Example: `"Business"`.
        </ResponseField>
      </ResponseField>

      <ResponseField name="user" type="string" />

      <ResponseField name="freshness_sla" type="string" />

      <ResponseField name="schema_stability" type="string" />

      <ResponseField name="sla_config" type="string" />

      <ResponseField name="definition" type="string">
        Example: `"Domain Test 7 is defined as a coherent set of business concepts, rules, and semantics that collectively describe a particular functional or operational area relevant to the organization's activities."`.
      </ResponseField>

      <ResponseField name="context" type="string" />

      <ResponseField name="who_should_use_this" type="string">
        Example: `"This domain is intended for business analysts, data stewards, and governance professionals who require a clear understanding of the domain's scope and semantics to ensure consistent data interpretation and usage across teams."`.
      </ResponseField>

      <ResponseField name="id" type="string">
        Example: `"51228e06-8b96-489e-be9a-93e4f4e7e9c2"`.
      </ResponseField>

      <ResponseField name="created_at" type="string">
        Example: `"2026-09-20T15:22:44.164059Z"`.
      </ResponseField>

      <ResponseField name="modified_at" type="string">
        Example: `"2026-09-21T06:39:16.442914Z"`.
      </ResponseField>

      <ResponseField name="created_by" type="string">
        Example: `"e67fcce2-34f6-48e5-b53c-5c8c4a209d2b"`.
      </ResponseField>

      <ResponseField name="modified_by" type="string">
        Example: `"eea07098-a9d0-4e66-aba0-5b297cc2a901"`.
      </ResponseField>

      <ResponseField name="linked_assets" type="integer">
        Example: `0`.
      </ResponseField>

      <ResponseField name="parents" type="object[]" />

      <ResponseField name="product" type="object[]" />

      <ResponseField name="glossary" type="object[]">
        <ResponseField name="id" type="string">
          Example: `"cfe79044-4173-4ad1-b9a7-edbf22ac0e35"`.
        </ResponseField>

        <ResponseField name="name" type="string">
          Example: `"Default Glossary"`.
        </ResponseField>

        <ResponseField name="label" type="string">
          Example: `"Default Glossary"`.
        </ResponseField>
      </ResponseField>

      <ResponseField name="tag" type="object[]" />

      <ResponseField name="term" type="object[]" />

      <ResponseField name="viewers" type="object[]">
        <ResponseField name="id" type="string">
          Example: `"08ba2090-a236-4538-a671-fca112ca8ad2"`.
        </ResponseField>

        <ResponseField name="viewed_at" type="string">
          Example: `"2026-09-21T10:32:23.082527+00:00"`.
        </ResponseField>

        <ResponseField name="name" type="string" />

        <ResponseField name="email" type="string">
          Example: `"rejeesh@dqlabs.ai"`.
        </ResponseField>
      </ResponseField>

      <ResponseField name="audiences" type="object[]" />

      <ResponseField name="recent_conversations" type="string" />

      <ResponseField name="context_freshness" type="object">
        <ResponseField name="description" type="string" />

        <ResponseField name="owner_verified" type="string" />
      </ResponseField>
    </ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/{domainId}" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>"
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Get a domain by ID",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {
        "name": "Domain Test 7",
        "description": "Domain Test 7 represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology.",
        "type": "domain",
        "level": 1,
        "source": null,
        "parent_id": null,
        "owner_team": null,
        "qualified_name": "Domain Test 7",
        "score": null,
        "total_alerts": 0,
        "total_issues": 0,
        "linked_asset_count": 0,
        "linked_metric_count": 0,
        "total_likes": null,
        "total_dislikes": null,
        "total_conversations": 0,
        "total_views": 4,
        "status": "VERIFIED",
        "is_active": true,
        "is_deleted": false,
        "owner": [
          {
            "id": "f78830aa-4fb0-448f-b36f-34aa318d1c35",
            "name": "data quality",
            "email": "data_quality@dqlabs.ai",
            "label": "data quality",
            "owner_type": "Business"
          }
        ],
        "user": null,
        "freshness_sla": null,
        "schema_stability": null,
        "sla_config": null,
        "definition": "Domain Test 7 is defined as a coherent set of business concepts, rules, and semantics that collectively describe a particular functional or operational area relevant to the organization's activities.",
        "context": null,
        "who_should_use_this": "This domain is intended for business analysts, data stewards, and governance professionals who require a clear understanding of the domain's scope and semantics to ensure consistent data interpretation and usage across teams.",
        "id": "51228e06-8b96-489e-be9a-93e4f4e7e9c2",
        "created_at": "2026-09-20T15:22:44.164059Z",
        "modified_at": "2026-09-21T06:39:16.442914Z",
        "created_by": "e67fcce2-34f6-48e5-b53c-5c8c4a209d2b",
        "modified_by": "eea07098-a9d0-4e66-aba0-5b297cc2a901",
        "linked_assets": 0,
        "parents": [],
        "product": [],
        "glossary": [
          {
            "id": "cfe79044-4173-4ad1-b9a7-edbf22ac0e35",
            "name": "Default Glossary",
            "label": "Default Glossary"
          }
        ],
        "tag": [],
        "term": [],
        "viewers": [
          {
            "id": "08ba2090-a236-4538-a671-fca112ca8ad2",
            "viewed_at": "2026-09-21T10:32:23.082527+00:00",
            "name": null,
            "email": "rejeesh@dqlabs.ai"
          }
        ],
        "audiences": [],
        "recent_conversations": null,
        "context_freshness": {
          "description": null,
          "owner_verified": null
        }
      }
    }
    ```
  </Tab>

  <Tab title="Get Domains">
    `POST /api/v1/governance/domain/list`

    Get domains with optional filtering

    **Request Body**

    <ParamField body="pagination" type="object">
      <ParamField body="page" type="integer">
        Example: `1`.
      </ParamField>

      <ParamField body="pageSize" type="integer">
        Example: `10`.
      </ParamField>
    </ParamField>

    <ParamField body="sorting" type="object[]" />

    <ParamField body="filters" type="object[]" />

    <ParamField body="search" type="string">
      Example: `""`.
    </ParamField>

    <ParamField body="export" type="boolean">
      Example: `false`.
    </ParamField>

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">
      <ResponseField name="data" type="object[]">
        <ResponseField name="name" type="string">
          Example: `"Domain Test 7"`.
        </ResponseField>

        <ResponseField name="description" type="string">
          Example: `"Domain Test 7 represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology."`.
        </ResponseField>

        <ResponseField name="type" type="string">
          Example: `"domain"`.
        </ResponseField>

        <ResponseField name="level" type="integer">
          Example: `1`.
        </ResponseField>

        <ResponseField name="qualified_name" type="string">
          Example: `"Domain Test 7"`.
        </ResponseField>

        <ResponseField name="total_alerts" type="integer">
          Example: `0`.
        </ResponseField>

        <ResponseField name="total_issues" type="integer">
          Example: `0`.
        </ResponseField>

        <ResponseField name="linked_asset_count" type="integer">
          Example: `0`.
        </ResponseField>

        <ResponseField name="linked_metric_count" type="integer">
          Example: `0`.
        </ResponseField>

        <ResponseField name="total_conversations" type="integer">
          Example: `0`.
        </ResponseField>

        <ResponseField name="total_views" type="integer">
          Example: `3`.
        </ResponseField>

        <ResponseField name="status" type="string">
          Example: `"VERIFIED"`.
        </ResponseField>

        <ResponseField name="is_active" type="boolean">
          Example: `true`.
        </ResponseField>

        <ResponseField name="is_deleted" type="boolean">
          Example: `false`.
        </ResponseField>

        <ResponseField name="owner" type="object[]">
          <ResponseField name="id" type="string">
            Example: `"f78830aa-4fb0-448f-b36f-34aa318d1c35"`.
          </ResponseField>

          <ResponseField name="name" type="string">
            Example: `"data quality"`.
          </ResponseField>

          <ResponseField name="email" type="string">
            Example: `"data_quality@dqlabs.ai"`.
          </ResponseField>

          <ResponseField name="label" type="string">
            Example: `"data quality"`.
          </ResponseField>

          <ResponseField name="owner_type" type="string">
            Example: `"Business"`.
          </ResponseField>
        </ResponseField>

        <ResponseField name="definition" type="string">
          Example: `"Domain Test 7 is defined as a coherent set of business concepts, rules, and semantics that collectively describe a particular functional or operational area relevant to the organization's activities."`.
        </ResponseField>

        <ResponseField name="who_should_use_this" type="string">
          Example: `"This domain is intended for business analysts, data stewards, and governance professionals who require a clear understanding of the domain's scope and semantics to ensure consistent data interpretation and usage across teams."`.
        </ResponseField>

        <ResponseField name="id" type="string">
          Example: `"51228e06-8b96-489e-be9a-93e4f4e7e9c2"`.
        </ResponseField>

        <ResponseField name="created_at" type="string">
          Example: `"2026-09-20T15:22:44.164059Z"`.
        </ResponseField>

        <ResponseField name="modified_at" type="string">
          Example: `"2026-09-20T19:16:40.211363Z"`.
        </ResponseField>

        <ResponseField name="created_by" type="string">
          Example: `"e67fcce2-34f6-48e5-b53c-5c8c4a209d2b"`.
        </ResponseField>

        <ResponseField name="modified_by" type="string">
          Example: `"eea07098-a9d0-4e66-aba0-5b297cc2a901"`.
        </ResponseField>

        <ResponseField name="linked_assets" type="integer">
          Example: `0`.
        </ResponseField>

        <ResponseField name="product" type="object[]" />

        <ResponseField name="glossary" type="object[]">
          <ResponseField name="id" type="string">
            Example: `"cfe79044-4173-4ad1-b9a7-edbf22ac0e35"`.
          </ResponseField>

          <ResponseField name="name" type="string">
            Example: `"Default Glossary"`.
          </ResponseField>

          <ResponseField name="label" type="string">
            Example: `"Default Glossary"`.
          </ResponseField>

          <ResponseField name="description" type="string" />

          <ResponseField name="source" type="string" />

          <ResponseField name="is_active" type="boolean">
            Example: `true`.
          </ResponseField>
        </ResponseField>

        <ResponseField name="tag" type="object[]" />

        <ResponseField name="term" type="object[]" />

        <ResponseField name="viewers" type="object[]" />

        <ResponseField name="audiences" type="object[]" />
      </ResponseField>

      <ResponseField name="total_count" type="integer">
        Example: `84`.
      </ResponseField>

      <ResponseField name="metrics" type="object[]" />
    </ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/list" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>" \
        -H "Content-Type: application/json" \
        -d '{
        "pagination": {
          "page": 1,
          "pageSize": 10
        },
        "sorting": [],
        "filters": [],
        "search": "",
        "export": false
      }'
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Get domains with optional filtering",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {
        "data": [
          {
            "name": "Domain Test 7",
            "description": "Domain Test 7 represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology.",
            "type": "domain",
            "level": 1,
            "qualified_name": "Domain Test 7",
            "total_alerts": 0,
            "total_issues": 0,
            "linked_asset_count": 0,
            "linked_metric_count": 0,
            "total_conversations": 0,
            "total_views": 3,
            "status": "VERIFIED",
            "is_active": true,
            "is_deleted": false,
            "owner": [
              {
                "id": "f78830aa-4fb0-448f-b36f-34aa318d1c35",
                "name": "data quality",
                "email": "data_quality@dqlabs.ai",
                "label": "data quality",
                "owner_type": "Business"
              }
            ],
            "definition": "Domain Test 7 is defined as a coherent set of business concepts, rules, and semantics that collectively describe a particular functional or operational area relevant to the organization's activities.",
            "who_should_use_this": "This domain is intended for business analysts, data stewards, and governance professionals who require a clear understanding of the domain's scope and semantics to ensure consistent data interpretation and usage across teams.",
            "id": "51228e06-8b96-489e-be9a-93e4f4e7e9c2",
            "created_at": "2026-09-20T15:22:44.164059Z",
            "modified_at": "2026-09-20T19:16:40.211363Z",
            "created_by": "e67fcce2-34f6-48e5-b53c-5c8c4a209d2b",
            "modified_by": "eea07098-a9d0-4e66-aba0-5b297cc2a901",
            "linked_assets": 0,
            "product": [],
            "glossary": [
              {
                "id": "cfe79044-4173-4ad1-b9a7-edbf22ac0e35",
                "name": "Default Glossary",
                "label": "Default Glossary",
                "description": null,
                "source": null,
                "is_active": true
              }
            ],
            "tag": [],
            "term": [],
            "viewers": [],
            "audiences": []
          }
        ],
        "total_count": 84,
        "metrics": []
      }
    }
    ```
  </Tab>

  <Tab title="Get Domains Tree List">
    `POST /api/v1/governance/domain/tree-view`

    Get all domains for tree list without filters, sort, limit, offset, but with has\_user\_filter

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">
      <ResponseField name="id" type="string">
        Example: `"46b2d452-858c-428f-8120-cd2ed170677a"`.
      </ResponseField>

      <ResponseField name="name" type="string">
        Example: `"import/export domain"`.
      </ResponseField>

      <ResponseField name="type" type="string">
        Example: `"domain"`.
      </ResponseField>

      <ResponseField name="parent_id" type="string" />

      <ResponseField name="status" type="string">
        Example: `"VERIFIED"`.
      </ResponseField>
    </ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/tree-view" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>" \
        -H "Content-Type: application/json" \
        -d '{}'
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Get all domains for tree list without filters, sort, limit, offset, but with has_user_filter",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {}
    }
    ```
  </Tab>

  <Tab title="Update Domain">
    `PUT /api/v1/governance/domain/{domainId}`

    Update a domain

    **Path Parameters**

    <ParamField path="domainId" type="string" required={true}>
      Example: \`\`
    </ParamField>

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">The endpoint's response payload.</ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X PUT "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/{domainId}" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>" \
        -H "Content-Type: application/json" \
        -d '{}'
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Update a domain",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {}
    }
    ```
  </Tab>

  <Tab title="Delete Domain">
    `DELETE /api/v1/governance/domain/{domainId}`

    Delete a domain

    **Path Parameters**

    <ParamField path="domainId" type="string" required={true}>
      Example: \`\`
    </ParamField>

    **Response**

    <ResponseField name="success" type="boolean">Whether the request completed successfully</ResponseField>

    <ResponseField name="message" type="string">Human-readable result message</ResponseField>

    <ResponseField name="timestamp" type="string">ISO 8601 server timestamp</ResponseField>

    <ResponseField name="correlation_id" type="string">Unique ID for this request</ResponseField>

    <ResponseField name="data" type="object">The endpoint's response payload.</ResponseField>

    **Example**

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/{domainId}" \
        -H "Authorization: Bearer <YOUR_API_TOKEN>"
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "success": true,
      "message": "Delete a domain",
      "timestamp": "2026-09-21T09:43:50.316067+00:00",
      "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
      "data": {}
    }
    ```
  </Tab>
</Tabs>