Product

POST /api/v1/governance/productCreate a new productRequest 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 domain the object belongs to.

string

Sensitivity classification, for example internal or confidential.

string

Team that owns the 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/product" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer 360",
    "description": "Unified customer data product",
    "domain_id": "4621afc0-0341-5daa-9be9-f08a475d6df1",
    "sensitivity_level": "internal",
    "owner_team": "Customer Analytics",
    "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": "Customer 360",
  "description": "Unified customer data product",
  "domain_id": "4621afc0-0341-5daa-9be9-f08a475d6df1",
  "sensitivity_level": "internal",
  "owner_team": "Customer Analytics",
  "owner": [
    "3573f1d4-9b56-5007-b086-b977fe00f6f2"
  ]
}

Response

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

POST /api/v1/governance/product/exportReturns export data for data products. Send the same body as the product 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/product/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/product/{productId}Get a product by IDPath Parameters

string

required

ID of the data product.

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

string

Example: "Source".

string

Example: "2f235088-c79e-57fc-9eec-28d4183ae0e9".

string

integer

Example: 0.

integer

Example: 0.

string

integer

Example: 0.

string

integer

Example: 2.

string

Example: "PENDING".

boolean

Example: true.

boolean

Example: false.

string

Example: "d80ec860-0bdc-5bc2-9e39-e319c35b930c".

string

Example: "2026-09-20T17:02:48.274860Z".

string

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

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

integer

Example: 0.

object[]

string

Example: "2f235088-c79e-57fc-9eec-28d4183ae0e9".

string

Example: "Finance Domain".

string

Example: "Finance Domain".

string

Example: "Finance Domain".

string

Example: "domain".

boolean

Example: true.

object[]

string

Example: "db688f6a-52a5-557c-b274-c64178cb0485".

string

Example: "order_management".

string

Example: "governance_application".

string

boolean

Example: true.

string

Example: "order_management".

object[]

string

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

string

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

string

Example: "user@example.com".

object[]

object

object[]

integer

Example: 0.

object

object[]

integer

Example: 0.

string

object

string

Example

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

Response

{
  "success": true,
  "message": "Get a product by ID",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "name": "governance_product",
    "qualified_name": null,
    "description": null,
    "type": "Source",
    "level": null,
    "source": null,
    "owner_team": null,
    "sensitivity_level": null,
    "channel": null,
    "parent_id": null,
    "domain_id": "2f235088-c79e-57fc-9eec-28d4183ae0e9",
    "trust_score": null,
    "score": null,
    "total_alerts": 0,
    "total_issues": 0,
    "linked_asset_count": null,
    "linked_metric_count": null,
    "total_likes": null,
    "total_dislikes": null,
    "total_conversations": 0,
    "output_port": null,
    "total_views": 2,
    "health_index": null,
    "freshness_sla_compliance_index": null,
    "adoption_usage_coverage_index": null,
    "business_impact_index": null,
    "owner": null,
    "user": null,
    "status": "PENDING",
    "is_active": true,
    "is_deleted": false,
    "freshness_sla": null,
    "schema_stability": null,
    "definition": null,
    "context": null,
    "who_should_use_this": null,
    "id": "d80ec860-0bdc-5bc2-9e39-e319c35b930c",
    "created_at": "2026-09-20T17:02:48.274860Z",
    "modified_at": "2026-09-21T06:39:16.447949Z",
    "created_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
    "modified_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
    "linked_assets": 0,
    "domain": [
      {
        "id": "2f235088-c79e-57fc-9eec-28d4183ae0e9",
        "name": "Finance Domain",
        "label": "Finance Domain",
        "qualified_name": "Finance Domain",
        "type": "domain",
        "is_active": true
      }
    ],
    "application": [
      {
        "id": "db688f6a-52a5-557c-b274-c64178cb0485",
        "name": "order_management",
        "qualified_name": "governance_application",
        "role": null,
        "description": null,
        "is_active": true,
        "label": "order_management"
      }
    ],
    "tag": [],
    "term": [],
    "viewers": [
      {
        "id": "b86c4d14-0768-5cde-a87e-43628f4ead14",
        "viewed_at": "2026-09-21T10:32:26.827300+00:00",
        "name": null,
        "email": "user@example.com"
      }
    ],
    "audiences": [],
    "catalog_upstream": {
      "items": [],
      "total_count": 0
    },
    "catalog_downstream": {
      "items": [],
      "total_count": 0
    },
    "recent_conversations": null,
    "context_freshness": {
      "description": null,
      "owner_verified": null
    }
  }
}

POST /api/v1/governance/product/{productId}/lineageGet product lineage graphRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Lineage direction: upstream, downstream or full.

integer

Number of levels to traverse.

Path Parameters

string

required

ID of the data product.

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[]

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/product/{productId}/lineage" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "direction": "full",
    "depth": 2
  }'

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

Request body

{
  "direction": "full",
  "depth": 2
}

Response

{
  "success": true,
  "message": "Get product lineage graph",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "nodes": [],
    "edges": []
  }
}

POST /api/v1/governance/product/{productId}/output-portGet output port for a productRequest 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.

Path Parameters

string

required

ID of the data product.

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/product/{productId}/output-port" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": []
  }'

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": []
}

Response

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

POST /api/v1/governance/product/listGet products 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: "governance_product".

string

Example: "Source".

string

Example: "2f235088-c79e-57fc-9eec-28d4183ae0e9".

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

integer

Example: 1.

string

Example: "PENDING".

boolean

Example: true.

boolean

Example: false.

string

Example: "d80ec860-0bdc-5bc2-9e39-e319c35b930c".

string

Example: "2026-09-20T17:02:48.274860Z".

string

Example: "2026-09-20T19:01:54.341732Z".

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

integer

Example: 0.

object[]

string

Example: "2f235088-c79e-57fc-9eec-28d4183ae0e9".

string

Example: "Finance Domain".

string

Example: "Finance Domain".

string

Example: "Finance Domain".

string

Example: "domain".

boolean

Example: true.

object[]

string

Example: "db688f6a-52a5-557c-b274-c64178cb0485".

string

Example: "order_management".

string

Example: "governance_application".

string

boolean

Example: true.

string

Example: "order_management".

object[]

integer

Example: 38.

object[]

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/product/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 products with optional filtering",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [
      {
        "name": "governance_product",
        "description": null,
        "type": "Source",
        "domain_id": "2f235088-c79e-57fc-9eec-28d4183ae0e9",
        "total_alerts": 0,
        "total_issues": 0,
        "total_conversations": 0,
        "total_views": 1,
        "status": "PENDING",
        "is_active": true,
        "is_deleted": false,
        "id": "d80ec860-0bdc-5bc2-9e39-e319c35b930c",
        "created_at": "2026-09-20T17:02:48.274860Z",
        "modified_at": "2026-09-20T19:01:54.341732Z",
        "created_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
        "modified_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
        "linked_assets": 0,
        "domain": [
          {
            "id": "2f235088-c79e-57fc-9eec-28d4183ae0e9",
            "name": "Finance Domain",
            "label": "Finance Domain",
            "qualified_name": "Finance Domain",
            "type": "domain",
            "is_active": true
          }
        ],
        "application": [
          {
            "id": "db688f6a-52a5-557c-b274-c64178cb0485",
            "name": "order_management",
            "qualified_name": "governance_application",
            "role": null,
            "description": null,
            "is_active": true,
            "label": "order_management"
          }
        ],
        "tag": [],
        "term": [],
        "viewers": [],
        "audiences": []
      }
    ],
    "total_count": 38,
    "metrics": []
  }
}

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

string

Free-text description.

string

Sensitivity classification, for example internal or confidential.

Path Parameters

string

required

ID of the data product.

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/product/{productId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Unified customer data product with order history",
    "sensitivity_level": "confidential"
  }'

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

Request body

{
  "description": "Unified customer data product with order history",
  "sensitivity_level": "confidential"
}

Response

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

PUT /api/v1/governance/product/{productId}/update/yamlUpdates a data product from a YAML definition.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

YAML definition of the data product.

Path Parameters

string

required

ID of the data product.

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/product/{productId}/update/yaml" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "yaml": "name: Customer 360\nowner_team: Customer Analytics\nsensitivity_level: internal\n"
  }'

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

Request body

{
  "yaml": "name: Customer 360\nowner_team: Customer Analytics\nsensitivity_level: internal\n"
}

Response

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

DELETE /api/v1/governance/product/{productId}Delete a productPath Parameters

string

required

ID of the data product.

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/product/{productId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Delete a product",
  "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