- Create Metric Template
- Get Metric Template
- List Metric Templates
- List Metric Template Metrics
- Update Metric Template
- Delete Metric Template
POST /api/v1/metrics/templateCreate a metric template.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
Display name.
string
Data quality dimension, for example
Completeness.string
Object category, for example
asset.string
Where the metric applies, for example
attribute.string
What the metric measures and why.
string
How a run passes, for example
threshold.boolean
Whether the object is active.
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/metrics/template" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Null Percentage",
"dimension": "Completeness",
"category": "Column",
"context": "attribute",
"purpose": "Detect missing values",
"pass_criteria": "threshold",
"is_active": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"name": "Null Percentage",
"dimension": "Completeness",
"category": "Column",
"context": "attribute",
"purpose": "Detect missing values",
"pass_criteria": "threshold",
"is_active": true
}
Response
{
"success": true,
"message": "Create a metric template.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
GET /api/v1/metrics/template/{templateId}Get one metric template by ID.Path Parametersstring
required
ID of the metric template.
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:
"Address_Completeness".string
Example:
"Completeness".string
Example:
"PENDING".string
Example:
"Business".string
Example:
"Query".string
Example:
"Parameter".string
object[]
object[]
object[]
object[]
object
integer
Example:
100.boolean
Example:
false.boolean
Example:
false.boolean
Example:
false.integer
Example:
20.integer
Example:
100.boolean
Example:
false.boolean
Example:
true.boolean
Example:
true.boolean
Example:
false.boolean
Example:
true.boolean
Example:
false.boolean
Example:
true.string
Example:
"5e798444-10b0-5890-b7f4-b4e216597404".integer
Example:
0.integer
Example:
0.integer
Example:
0.integer
Example:
0.object[]
string
Example:
"2026-09-21T07:05:39.764359Z".string
Example:
"7c5de220-b00e-5407-896c-998e70e58d93".curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/metrics/template/{templateId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Get one metric template by ID.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"name": "Address_Completeness",
"dimension": "Completeness",
"status": "PENDING",
"context": "Business",
"category": "Query",
"subcategory": "Parameter",
"purpose": null,
"owner": [
{
"id": "7c5de220-b00e-5407-896c-998e70e58d93",
"name": "Jane Doe",
"label": "Jane Doe",
"owner_type": "Steward"
}
],
"audience": [],
"detected_parameters": [],
"properties": [],
"pass_criteria": {},
"threshold_constraint": {
"auto": [],
"mode": "auto",
"custom": [],
"manual": []
},
"weightage": 100,
"enabled_total_records": false,
"enabled_failed_rows": false,
"enabled_export_rows": false,
"column_limit": 20,
"row_limit": 100,
"is_aggregate": false,
"allow_score": true,
"auto_threshold": true,
"mute_notification": false,
"is_drift_enabled": true,
"is_positive": false,
"is_active": true,
"id": "5e798444-10b0-5890-b7f4-b4e216597404",
"total_issue": 0,
"total_alert": 0,
"total_views": 0,
"assigned_metric_count": 0,
"segments": [],
"created_at": "2026-09-21T07:05:39.764359Z",
"created_by": "7c5de220-b00e-5407-896c-998e70e58d93"
}
}
POST /api/v1/metrics/template/listList metric templates with optional export.Request 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:
"Address_Completeness".string
Example:
"Completeness".string
Example:
"PENDING".string
Example:
"Business".string
Example:
"Query".string
Example:
"Parameter".string
object[]
object[]
object[]
object[]
object
integer
Example:
100.boolean
Example:
false.boolean
Example:
false.boolean
Example:
false.integer
Example:
20.integer
Example:
100.boolean
Example:
false.boolean
Example:
true.boolean
Example:
true.boolean
Example:
false.boolean
Example:
false.boolean
Example:
true.boolean
Example:
true.string
Example:
"5e798444-10b0-5890-b7f4-b4e216597404".integer
Example:
0.integer
Example:
0.integer
Example:
0.integer
Example:
0.object[]
string
Example:
"2026-09-21T07:05:39.764359Z".string
Example:
"7c5de220-b00e-5407-896c-998e70e58d93".integer
Example:
11.curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/metrics/template/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": "List metric templates with optional export.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"data": [
{
"name": "Address_Completeness",
"dimension": "Completeness",
"status": "PENDING",
"context": "Business",
"category": "Query",
"subcategory": "Parameter",
"purpose": null,
"owner": [
{
"id": "7c5de220-b00e-5407-896c-998e70e58d93",
"name": "Jane Doe",
"label": "Jane Doe",
"owner_type": "Steward"
}
],
"audience": [],
"detected_parameters": [],
"properties": [],
"pass_criteria": {},
"threshold_constraint": {
"mode": "auto",
"auto": [],
"custom": [],
"manual": []
},
"weightage": 100,
"enabled_total_records": false,
"enabled_failed_rows": false,
"enabled_export_rows": false,
"column_limit": 20,
"row_limit": 100,
"is_aggregate": false,
"allow_score": true,
"auto_threshold": true,
"mute_notification": false,
"is_drift_enabled": false,
"is_positive": true,
"is_active": true,
"id": "5e798444-10b0-5890-b7f4-b4e216597404",
"total_issue": 0,
"total_alert": 0,
"total_views": 0,
"assigned_metric_count": 0,
"segments": [],
"created_at": "2026-09-21T07:05:39.764359Z",
"created_by": "7c5de220-b00e-5407-896c-998e70e58d93"
}
],
"total_count": 11
}
}
GET /api/v1/metrics/template/{templateId}/metricsList metrics assigned to a template.Path Parametersstring
required
ID of the metric template.
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 GET "https://<your-workspace>.prizmdata.ai/api/v1/metrics/template/{templateId}/metrics" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "List metrics assigned to a template.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
PUT /api/v1/metrics/template/{templateId}Update a metric template.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
What the metric measures and why.
boolean
Whether the object is active.
string
required
ID of the metric template.
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/metrics/template/{templateId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"purpose": "Detect missing or blank values",
"is_active": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"purpose": "Detect missing or blank values",
"is_active": true
}
Response
{
"success": true,
"message": "Update a metric template.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
DELETE /api/v1/metrics/template/{templateId}Delete a metric template.Path Parametersstring
required
ID of the metric template.
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/metrics/template/{templateId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Delete a metric template.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}