Domain

POST /api/v1/governance/domainCreate a new domainRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Display name.

string

Free-text description.

string

ID of the parent object, or null for a top-level object.

array

Array of user IDs that own the object.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Finance",
    "description": "Financial reporting and accounting data",
    "parent_id": null,
    "owner": [
      "3573f1d4-9b56-5007-b086-b977fe00f6f2"
    ]
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "name": "Finance",
  "description": "Financial reporting and accounting data",
  "parent_id": null,
  "owner": [
    "3573f1d4-9b56-5007-b086-b977fe00f6f2"
  ]
}

Response

{
  "success": true,
  "message": "Create a new domain",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

POST /api/v1/governance/domain/exportReturns export data for domains. Send the same body as the domain list endpoint with export set to true.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

object

Page settings.

integer

Page number, starting at 1.

integer

Records per page.

string

Free-text search term.

array

Array of filter objects.

array

Array of sort instructions.

boolean

Set to true to request export output.

string

Free-text search applied across all columns.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

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 '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "export": true,
    "globalSearch": ""
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": [],
  "export": true,
  "globalSearch": ""
}

Response

{
  "success": true,
  "message": "Get Export Data",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

GET /api/v1/governance/domain/{domainId}Get a domain by IDPath Parameters

string

required

ID of the domain.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

string

Example: "Customer Domain".

string

Example:

"Customer Domain represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology."

string

Example: "domain".

integer

Example: 1.

string

Example: "Customer Domain".

string

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

string

integer

Example: 0.

integer

Example: 4.

string

Example: "VERIFIED".

boolean

Example: true.

boolean

Example: false.

object[]

string

Example: "92b93e6f-5ca7-5912-9380-43418f99587e".

string

Example: "Data Steward".

string

Example: "user@example.com".

string

Example: "Data Steward".

string

Example: "Business".

string

Example:

"Customer Domain 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."

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."

string

Example: "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2".

string

Example: "2026-09-20T15:22:44.164059Z".

string

Example: "2026-09-21T06:39:16.442914Z".

string

Example: "892de25a-54a1-5739-ba50-f45697e10db2".

string

Example: "42f44c5b-1663-5e69-bae9-7a91a6df38ca".

integer

Example: 0.

object[]

string

Example: "41678e8a-e917-5c80-b24c-918e7f180416".

string

Example: "Default Glossary".

string

Example: "Default Glossary".

object[]

string

Example: "b86c4d14-0768-5cde-a87e-43628f4ead14".

string

Example: "2026-09-21T10:32:23.082527+00:00".

string

Example: "user@example.com".

object[]

string

object

string

Example

curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/{domainId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "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": "Customer Domain",
    "description": "Customer Domain 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": "Customer Domain",
    "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": "92b93e6f-5ca7-5912-9380-43418f99587e",
        "name": "Data Steward",
        "email": "user@example.com",
        "label": "Data Steward",
        "owner_type": "Business"
      }
    ],
    "user": null,
    "freshness_sla": null,
    "schema_stability": null,
    "sla_config": null,
    "definition": "Customer Domain 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": "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2",
    "created_at": "2026-09-20T15:22:44.164059Z",
    "modified_at": "2026-09-21T06:39:16.442914Z",
    "created_by": "892de25a-54a1-5739-ba50-f45697e10db2",
    "modified_by": "42f44c5b-1663-5e69-bae9-7a91a6df38ca",
    "linked_assets": 0,
    "parents": [],
    "product": [],
    "glossary": [
      {
        "id": "41678e8a-e917-5c80-b24c-918e7f180416",
        "name": "Default Glossary",
        "label": "Default Glossary"
      }
    ],
    "tag": [],
    "term": [],
    "viewers": [
      {
        "id": "b86c4d14-0768-5cde-a87e-43628f4ead14",
        "viewed_at": "2026-09-21T10:32:23.082527+00:00",
        "name": null,
        "email": "user@example.com"
      }
    ],
    "audiences": [],
    "recent_conversations": null,
    "context_freshness": {
      "description": null,
      "owner_verified": null
    }
  }
}

POST /api/v1/governance/domain/listGet domains with optional filteringRequest Body

object

integer

Example: 1.

integer

Example: 10.

object[]

string

Example: "".

boolean

Example: false.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

object[]

string

Example: "Customer Domain".

string

Example:

"Customer Domain represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology."

string

Example: "domain".

integer

Example: 1.

string

Example: "Customer Domain".

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

integer

Example: 3.

string

Example: "VERIFIED".

boolean

Example: true.

boolean

Example: false.

object[]

string

Example: "92b93e6f-5ca7-5912-9380-43418f99587e".

string

Example: "Data Steward".

string

Example: "user@example.com".

string

Example: "Data Steward".

string

Example: "Business".

string

Example:

"Customer Domain 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."

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."

string

Example: "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2".

string

Example: "2026-09-20T15:22:44.164059Z".

string

Example: "2026-09-20T19:16:40.211363Z".

string

Example: "892de25a-54a1-5739-ba50-f45697e10db2".

string

Example: "42f44c5b-1663-5e69-bae9-7a91a6df38ca".

integer

Example: 0.

object[]

string

Example: "41678e8a-e917-5c80-b24c-918e7f180416".

string

Example: "Default Glossary".

string

Example: "Default Glossary".

string

boolean

Example: true.

object[]

integer

Example: 84.

object[]

Example

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
}'

Response

{
  "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": "Customer Domain",
        "description": "Customer Domain represents a specific business domain within the organization, encapsulating a distinct area of business knowledge and terminology.",
        "type": "domain",
        "level": 1,
        "qualified_name": "Customer Domain",
        "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": "92b93e6f-5ca7-5912-9380-43418f99587e",
            "name": "Data Steward",
            "email": "user@example.com",
            "label": "Data Steward",
            "owner_type": "Business"
          }
        ],
        "definition": "Customer Domain 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": "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2",
        "created_at": "2026-09-20T15:22:44.164059Z",
        "modified_at": "2026-09-20T19:16:40.211363Z",
        "created_by": "892de25a-54a1-5739-ba50-f45697e10db2",
        "modified_by": "42f44c5b-1663-5e69-bae9-7a91a6df38ca",
        "linked_assets": 0,
        "product": [],
        "glossary": [
          {
            "id": "41678e8a-e917-5c80-b24c-918e7f180416",
            "name": "Default Glossary",
            "label": "Default Glossary",
            "description": null,
            "source": null,
            "is_active": true
          }
        ],
        "tag": [],
        "term": [],
        "viewers": [],
        "audiences": []
      }
    ],
    "total_count": 84,
    "metrics": []
  }
}

POST /api/v1/governance/domain/tree-viewGet all domains for tree list without filters, sort, limit, offset, but with has_user_filterRequest Body

boolean

Restrict results to the current user’s access filter when true.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

string

Example: "f388e702-5779-5e2e-b5d8-3f65133fc995".

string

Example: "Finance Operations".

string

Example: "domain".

string

Example: "VERIFIED".

Example

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 '{
    "hasUserFilter": false
  }'

This request body matches the payload the Prizm web app sends for this endpoint. IDs and values are placeholders.

Request body

{
  "hasUserFilter": false
}

Response

{
  "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": {}
}

PUT /api/v1/governance/domain/{domainId}Update a domainRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Display name.

string

Free-text description.

array

Array of user IDs that own the object.

Path Parameters

string

required

ID of the domain.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

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 '{
    "name": "Finance",
    "description": "Financial reporting, accounting and treasury data",
    "owner": [
      "3573f1d4-9b56-5007-b086-b977fe00f6f2"
    ]
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "name": "Finance",
  "description": "Financial reporting, accounting and treasury data",
  "owner": [
    "3573f1d4-9b56-5007-b086-b977fe00f6f2"
  ]
}

Response

{
  "success": true,
  "message": "Update a domain",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

DELETE /api/v1/governance/domain/{domainId}Delete a domainPath Parameters

string

required

ID of the domain.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/governance/domain/{domainId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Delete a domain",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

Get Started

Core

Metrics

Schedule

Notification

Integrations

Governance

Logging