Views

Get Export Data
Get Metrics From Latest View
Get Metric Latest

POST /api/v1/metrics/views/exportReturns export data for the latest metric results. Send the same body as the metric view 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

Object category, for example asset.

string

ID of the asset.

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/views/export" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "export": true,
    "category": "asset",
    "asset_id": "de895cb6-3810-58a4-937a-f54da5201882"
  }'

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,
  "category": "asset",
  "asset_id": "de895cb6-3810-58a4-937a-f54da5201882"
}

Response

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

POST /api/v1/metrics/views/metric-latestGet metrics from metric list with filters and pagination.Request Body

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

ID of the asset.

string

Object category, for example asset.

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: "257b3d97-4848-59a2-aa6c-d77b9c742919".

string

Example: "customer_term".

string

Example: "customer_term".

string

Example: "text".

string

Example: "Attribute".

object[]

string

Example: " SELECT COUNT(*) FROM \"analytics\".\"dbo\".\"CUSTOMER_ORDERS\" WHERE \"CUSTOMER_ID\" IS NULL".

integer

Example: 100.

integer

Example: 0.

object[]

integer

Example: 0.

string

Example: "PENDING".

string

Example: "Semantic".

string

object

object[]

string

Example: "2ed25759-766d-5473-a72a-b3eac15d3769".

string

Example: "analytics".

string

Example: "DATABASE".

object[]

string

Example: "257b3d97-4848-59a2-aa6c-d77b9c742919".

string

Example: "629c94df-0e1f-5040-8bfc-b7a451102d89".

string

Example: "Query".

string

Example: "Consistency".

boolean

Example: true.

boolean

Example: false.

string

Example: "406b3a01-9ccd-5ed0-a693-3c8e908bbcc4".

string

integer

Example: 100.

string

Example: "a0ceefd1-18f1-53eb-ae42-d2774d761418".

object

number

Example: 0.0.

number

Example: 0.0.

integer

Example: 100.

string

Example: "CUSTOMER_ID".

string

Example: "ATTRIBUTE".

string

Example: "2026-09-20T19:07:22.142959+00:00".

string

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

boolean

Example: false.

string

Example: "COMPLETED".

object

string

Example:

"This metric measures the consistency of semantic terms within the query context, ensuring that glossary terms are used accurately and uniformly. It is applied at the term level within a semantic glossary asset, focusing on the consistency dimension. The metric is evaluated periodically using aggregation logic relevant to semantic consistency checks, although specific frequency details are not provided. Maintaining semantic consistency is crucial for data trust as it ensures clear and unambiguous communication of data definitions, supporting reliable data interpretation and decision-making."

boolean

Example: true.

object[]

string

boolean

Example: true.

boolean

Example: false.

string

Example: "null_check".

string

Example: "custom".

string

Example: "2026-09-20T19:11:02.563761+00:00".

string

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

object[]

string

Example: "3aca6f33-b2dc-5c13-b0d0-4373640d86d6".

string

Example: "2026-09-20 19:10:48.285349+00".

string

Example: "OK".

string

Example: "sales_db".

string

Example: "MSSQL".

string

Example: "Glossary".

integer

Example: 20.

boolean

Example: false.

boolean

Example: false.

string

integer

Example: 0.

string

Example: "3aca6f33-b2dc-5c13-b0d0-4373640d86d6".

object

integer

Example: 634067.

integer

Example: 634067.

boolean

Example: true.

string

Example: "\"analytics\".\"dbo\".\"CUSTOMER_ORDERS\".\"CUSTOMER_ID\"".

string

Example: "728dc346-7dd2-5b08-9855-91959d7c700a".

string

integer

Example: 0.

boolean

Example: false.

string

Example: "e6ab726e-2f6b-5ca2-aba4-4029d02ad401".

boolean

Example: true.

string

Example: "60dda31e-d69c-55cf-8b73-1ad3eed4007c".

integer

Example: 100.

string

Example: "2ed25759-766d-5473-a72a-b3eac15d3769".

string

integer

Example: 0.

string

Example: "custom".

string

boolean

Example: false.

boolean

Example: false.

boolean

Example: true.

string

Example: "2026-09-20T19:10:48.285349+00:00".

string

object

string[]

string

Example: "auto".

object[]

boolean

Example: false.

integer

Example: 65761.

object[]

string

Example: "Availability".

string

Example: "Availability".

integer

Example: 32641.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/metrics/views/metric-latest" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "export": false,
    "asset_id": "de895cb6-3810-58a4-937a-f54da5201882",
    "category": "asset"
  }'

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

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": [],
  "export": false,
  "asset_id": "de895cb6-3810-58a4-937a-f54da5201882",
  "category": "asset"
}

Response

{
  "success": true,
  "message": "Get metrics from metric list with filters and pagination.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [
      {
        "tag": [],
        "term": [
          {
            "id": "257b3d97-4848-59a2-aa6c-d77b9c742919",
            "name": "customer_term",
            "label": "customer_term",
            "datatype": "text"
          }
        ],
        "level": "Attribute",
        "owner": [],
        "query": " SELECT COUNT(*) FROM \"analytics\".\"dbo\".\"CUSTOMER_ORDERS\" WHERE \"CUSTOMER_ID\" IS NULL",
        "score": 100,
        "alerts": 0,
        "domain": [],
        "issues": 0,
        "status": "PENDING",
        "context": "Semantic",
        "is_pass": null,
        "metrics": {},
        "parents": [
          {
            "id": "2ed25759-766d-5473-a72a-b3eac15d3769",
            "name": "analytics",
            "type": "DATABASE"
          }
        ],
        "product": [],
        "purpose": null,
        "term_id": "257b3d97-4848-59a2-aa6c-d77b9c742919",
        "asset_id": "629c94df-0e1f-5040-8bfc-b7a451102d89",
        "category": "Query",
        "dimension": "Consistency",
        "is_active": true,
        "is_delete": false,
        "metric_id": "406b3a01-9ccd-5ed0-a693-3c8e908bbcc4",
        "rationale": null,
        "row_limit": 100,
        "source_id": "a0ceefd1-18f1-53eb-ae42-d2774d761418",
        "threshold": {
          "lower_threshold": 0.0,
          "upper_threshold": 0.0
        },
        "weightage": 100,
        "asset_name": "CUSTOMER_ID",
        "asset_type": "ATTRIBUTE",
        "created_at": "2026-09-20T19:07:22.142959+00:00",
        "created_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
        "is_default": false,
        "properties": null,
        "run_status": "COMPLETED",
        "ai_insights": {
          "summary": "This metric measures the consistency of semantic terms within the query context, ensuring that glossary terms are used accurately and uniformly. It is applied at the term level within a semantic glossary asset, focusing on the consistency dimension. The metric is evaluated periodically using aggregation logic relevant to semantic consistency checks, although specific frequency details are not provided. Maintaining semantic consistency is crucial for data trust as it ensures clear and unambiguous communication of data definitions, supporting reliable data interpretation and decision-making."
        },
        "allow_score": true,
        "application": [],
        "description": null,
        "is_approved": true,
        "is_positive": false,
        "metric_name": "null_check",
        "metric_type": "custom",
        "modified_at": "2026-09-20T19:11:02.563761+00:00",
        "modified_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
        "recent_runs": [
          {
            "range": null,
            "run_id": "3aca6f33-b2dc-5c13-b0d0-4373640d86d6",
            "marked_as": null,
            "collected_at": "2026-09-20 19:10:48.285349+00",
            "alert_priority": "OK"
          }
        ],
        "source_name": "sales_db",
        "source_type": "MSSQL",
        "subcategory": "Glossary",
        "column_limit": 20,
        "is_aggregate": false,
        "is_validated": false,
        "job_asset_id": null,
        "metric_value": 0,
        "error_message": null,
        "latest_run_id": "3aca6f33-b2dc-5c13-b0d0-4373640d86d6",
        "pass_criteria": {},
        "total_records": 634067,
        "valid_records": 634067,
        "auto_threshold": true,
        "qualified_name": "\"analytics\".\"dbo\".\"CUSTOMER_ORDERS\".\"CUSTOMER_ID\"",
        "table_asset_id": "728dc346-7dd2-5b08-9855-91959d7c700a",
        "disable_scoring": null,
        "invalid_records": 0,
        "is_ai_generated": false,
        "schema_asset_id": "e6ab726e-2f6b-5ca2-aba4-4029d02ad401",
        "is_drift_enabled": true,
        "metric_detail_id": "60dda31e-d69c-55cf-8b73-1ad3eed4007c",
        "valid_percentage": 100,
        "database_asset_id": "2ed25759-766d-5473-a72a-b3eac15d3769",
        "failed_rows_query": null,
        "pipeline_asset_id": null,
        "invalid_percentage": 0,
        "metric_detail_type": "custom",
        "metric_template_id": null,
        "enabled_export_rows": false,
        "enabled_failed_rows": false,
        "is_metric_validated": true,
        "metric_collected_at": "2026-09-20T19:10:48.285349+00:00",
        "total_records_query": null,
        "metric_template_name": null,
        "threshold_constraint": {
          "auto": [],
          "mode": "auto",
          "custom": [],
          "manual": []
        },
        "enabled_total_records": false
      }
    ],
    "total_count": 65761,
    "metrics": [
      {
        "type": "Availability",
        "title": "Availability",
        "value": 32641
      }
    ]
  }
}

GET /api/v1/metrics/views/{metricDetailId}Get metric latest by metric_detail_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/views/{metricDetailId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Get metric latest by metric_detail_id",
  "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