- Create Tag
- Get Export Data
- Get Tag
- Get Tags
- Get Tags Tree List
- Update Tag
- Delete Tag
POST /api/v1/governance/tagCreate a new tagRequest 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.
boolean
Whether data tagged with this tag is masked.
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.
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "PII",
"description": "Contains personally identifiable information",
"is_masked_data": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"name": "PII",
"description": "Contains personally identifiable information",
"is_masked_data": true
}
Response
{
"success": true,
"message": "Create a new tag",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
POST /api/v1/governance/tag/exportReturns export data for tags. Send the same body as the tag 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.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.
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.
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag/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/tag/{tagId}Get a tag by IDPath Parametersstring
required
ID of the tag.
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:
"sales_schema".string
Example:
"Customer ID".string
string
string
Example:
"mssql".string
Example:
"SELECT * FROM sys.sensitivity_classifications ...".string
string
Example:
"PENDING".boolean
Example:
false.boolean
Example:
true.boolean
Example:
false.string
integer
Example:
0.integer
Example:
0.integer
Example:
0.string
string
integer
Example:
0.integer
Example:
1.string
string
string
Example:
"analytics.L2.sales_schema".string
string
string
string
string
string
Example:
"abe46028-9130-5570-9d05-251df3647dea".string
Example:
"239e95f0-7fc1-5830-8787-0682438ac8a1".string
Example:
"MSSQL".string
Example:
"2026-09-20T15:46:27.529179Z".string
Example:
"2026-09-21T06:39:16.453175Z".string
string
integer
Example:
0.object[]
object[]
object[]
string
curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag/{tagId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Get a tag by ID",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"name": "sales_schema",
"description": "Customer ID",
"type": null,
"level": null,
"source": "mssql",
"native_query_run": "SELECT * FROM sys.sensitivity_classifications ...",
"parent_id": null,
"status": "PENDING",
"is_masked_data": false,
"is_active": true,
"is_deleted": false,
"score": null,
"total_alerts": 0,
"total_issues": 0,
"linked_asset_count": 0,
"total_likes": null,
"total_dislikes": null,
"total_conversations": 0,
"total_views": 1,
"owner": null,
"user": null,
"qualified_name": "analytics.L2.sales_schema",
"freshness_sla": null,
"schema_stability": null,
"definition": null,
"context": null,
"who_should_use_this": null,
"id": "abe46028-9130-5570-9d05-251df3647dea",
"source_id": "239e95f0-7fc1-5830-8787-0682438ac8a1",
"source_type": "MSSQL",
"created_at": "2026-09-20T15:46:27.529179Z",
"modified_at": "2026-09-21T06:39:16.453175Z",
"created_by": null,
"modified_by": null,
"linked_assets": 0,
"parents": [],
"viewers": [
{
"id": "b86c4d14-0768-5cde-a87e-43628f4ead14",
"viewed_at": "2026-09-21T10:32:30.226257+00:00",
"name": null,
"email": "user@example.com"
}
],
"audiences": [],
"recent_conversations": null,
"context_freshness": {
"description": null,
"owner_verified": null
}
}
}
POST /api/v1/governance/tag/listGet tags with optional filteringRequest Bodyobject[]
object[]
string
Example:
"".boolean
Example:
false.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:
"sales_schema".string
Example:
"Customer ID".string
Example:
"mssql".string
Example:
"SELECT * FROM sys.sensitivity_classifications ...".string
Example:
"PENDING".boolean
Example:
false.boolean
Example:
true.boolean
Example:
false.integer
Example:
0.integer
Example:
0.integer
Example:
0.integer
Example:
0.string
Example:
"analytics.L2.sales_schema".string
Example:
"abe46028-9130-5570-9d05-251df3647dea".string
Example:
"239e95f0-7fc1-5830-8787-0682438ac8a1".string
Example:
"MSSQL".string
Example:
"2026-09-20T15:46:27.529179Z".string
Example:
"2026-09-20T15:46:18.069478Z".integer
Example:
0.object[]
object[]
integer
Example:
424.object[]
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag/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 tags with optional filtering",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"data": [
{
"name": "sales_schema",
"description": "Customer ID",
"source": "mssql",
"native_query_run": "SELECT * FROM sys.sensitivity_classifications ...",
"status": "PENDING",
"is_masked_data": false,
"is_active": true,
"is_deleted": false,
"total_alerts": 0,
"total_issues": 0,
"linked_asset_count": 0,
"total_conversations": 0,
"qualified_name": "analytics.L2.sales_schema",
"id": "abe46028-9130-5570-9d05-251df3647dea",
"source_id": "239e95f0-7fc1-5830-8787-0682438ac8a1",
"source_type": "MSSQL",
"created_at": "2026-09-20T15:46:27.529179Z",
"modified_at": "2026-09-20T15:46:18.069478Z",
"linked_assets": 0,
"viewers": [],
"audiences": []
}
],
"total_count": 424,
"metrics": []
}
}
POST /api/v1/governance/tag/tree-viewGet all tags for tree list without filters, sort, limit, offset, but with has_user_filterRequest Bodyboolean
Restrict results to the current user’s access filter when
true.boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag/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 tags 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/tag/{tagId}Update a tagRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
Free-text description.
boolean
Whether data tagged with this tag is masked.
string
required
ID of the tag.
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.
curl -X PUT "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag/{tagId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"description": "Contains personally identifiable information (GDPR scope)",
"is_masked_data": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"description": "Contains personally identifiable information (GDPR scope)",
"is_masked_data": true
}
Response
{
"success": true,
"message": "Update a tag",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
DELETE /api/v1/governance/tag/{tagId}Delete a tagPath Parametersstring
required
ID of the tag.
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.
curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/governance/tag/{tagId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Delete a tag",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}