Detail

Create Metric Detail
Get Metric Details By Asset
Get Metric Detail
Update Metric Detail
Delete Metric Detail

POST /api/v1/metrics/detailCreate a new metric detail.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

ID of the metric.

string

ID of the asset.

string

Display name.

string

Data quality dimension, for example Completeness.

string

How a run passes, for example threshold.

object

Threshold rule for a pass.

string

Comparison operator, for example >=.

integer

Value to set.

boolean

Whether the object is active.

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/metrics/detail" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "metric_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
    "asset_id": "de895cb6-3810-58a4-937a-f54da5201882",
    "name": "Null check - customer_id",
    "dimension": "Completeness",
    "pass_criteria": "threshold",
    "threshold_constraint": {
      "operator": ">=",
      "value": 99
    },
    "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

{
  "metric_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
  "asset_id": "de895cb6-3810-58a4-937a-f54da5201882",
  "name": "Null check - customer_id",
  "dimension": "Completeness",
  "pass_criteria": "threshold",
  "threshold_constraint": {
    "operator": ">=",
    "value": 99
  },
  "is_active": true
}

Response

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

GET /api/v1/metrics/detail/asset/{assetId}Get all metric details for a specific assetPath Parameters

string

required

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

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

string

Example: "Counts the number of null values in a column to assess data completeness and quality.".

string

Example: "distribution".

string

Example: "ATTRIBUTE".

string

Example: "VERIFIED".

boolean

Example: false.

boolean

Example: true.

boolean

Example: false.

boolean

Example: true.

boolean

Example: false.

boolean

Example: true.

boolean

Example: true.

boolean

Example: false.

boolean

Example: false.

integer

Example: 100.

object

number

Example: 43.0.

number

Example: 43.0.

object

string[]

string

Example: "auto".

object[]

string

Example: "9eee124e-655a-5446-b3b3-a1afbc34de4c".

string

Example: "f8643a23-3713-517d-a75c-58cfcb7d5ecc".

string

Example: "Structural".

string

Example: "Distribution".

string

Example: "Completeness".

string

Example: "Completeness".

string

Example: "Attribute".

boolean

Example: false.

boolean

Example: false.

boolean

Example: false.

integer

Example: 20.

integer

Example: 100.

object[]

string

Example: "d089bea7-1a0e-5e6c-aea6-3ba2bbf08677".

boolean

Example: true.

string

Example: "To measure attribute-level completeness and ensure critical business fields contain meaningful and usable information.".

string

Example:

"Excessive null values may indicate incomplete ingestion, missing source data, or breakdowns in upstream processing pipelines."

object

integer

Example: 0.

object

string

Example: "47b2517f-f878-5d5f-a9cd-d831889ef407".

string

Example: "2026-09-19T11:31:28.106907Z".

string

Example: "2026-09-20T17:08:29.125354Z".

Example

curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/metrics/detail/asset/{assetId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

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

GET /api/v1/metrics/detail/{metricDetailId}Get a metric detail by IDPath Parameters

string

required

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

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 GET "https://<your-workspace>.prizmdata.ai/api/v1/metrics/detail/{metricDetailId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

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

PUT /api/v1/metrics/detail/{metricDetailId}Update a metric detail.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

object

Threshold rule for a pass.

string

Comparison operator, for example >=.

integer

Value to set.

boolean

Whether the object is active.

Path Parameters

string

required

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

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/metrics/detail/{metricDetailId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "threshold_constraint": {
      "operator": ">=",
      "value": 98
    },
    "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

{
  "threshold_constraint": {
    "operator": ">=",
    "value": 98
  },
  "is_active": true
}

Response

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

DELETE /api/v1/metrics/detail/{metricDetailId}Delete a metric detailPath Parameters

string

required

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

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/metrics/detail/{metricDetailId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

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