Response & Error Format

This page documents what’s confirmed from the current API collection. The data field’s contents are still being documented per endpoint — see the note in API Overview.

Response envelope

Every endpoint returns the same top-level shape (confirmed from a live capture against GET /api/v1/core/asset/{assetId}):

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

Field	Type	Description
`success`	boolean	Whether the request completed successfully
`message`	string	Human-readable description of the result
`timestamp`	string (ISO 8601)	Server time the response was generated
`correlation_id`	string (UUID)	Unique ID for this request — include it when contacting support about a specific call
`data`	object	The endpoint’s actual payload — shape varies per endpoint. Confirmed field-by-field for endpoints marked so on their reference page; other endpoints still show a placeholder until captured

timestamp and correlation_id were confirmed on one endpoint (GET /api/v1/core/asset/{assetId}) and are assumed to be a shared response-wrapper convention across the API. That assumption will be confirmed or corrected as more endpoints are captured.

List, filter, sort, and search

Endpoints that return a collection (typically named .../list) accept a consistent request body rather than query parameters:

{
  "pagination": { "page": 1, "pageSize": 10 },
  "sorting": [],
  "filters": [],
  "search": "",
  "export": false
}

Field	Type	Description
`pagination.page`	integer	Page number, starting at 1
`pagination.pageSize`	integer	Records per page
`sorting`	array	Sort instructions. Send `[]` for the default order. The shape of a sort item is not yet confirmed.
`filters`	array	Filter objects, see Filter objects. Send `[]` for no filtering.
`search`	string	Free-text search term
`globalSearch`	string	Free-text search across all columns. Sent by some list endpoints.
`export`	boolean	Set to `true` to request export output

Some list endpoints take extra body fields on top of these, for example asset_id and category on the metric view list, or id and type on the audit log list. These are shown in the example on each endpoint’s page.

Filter objects

Each item in filters narrows the result set on one column:

{
  "filters": [
    { "column": "type", "operator": "Is", "value": "TABLE", "type": "text" },
    { "column": "source_type", "operator": "Is", "value": ["SNOWFLAKE", "DATABRICKS"], "type": "select" }
  ]
}

Field	Type	Description
`column`	string	Name of the column to filter on, as it appears in the list response
`operator`	string	Comparison operator. `Is` is the operator used by the Prizm web app for equality filters
`value`	string or array	Value to match. Some columns accept an array of values
`type`	string	Input type of the column, for example `text` or `select`

The Prizm web app also sends isDefault and filterType (for example card or nav) on filters that come from its built-in cards and navigation. These describe how the filter was created in the UI and are not needed for API calls. The full list of columns and operators per endpoint is not yet documented.

Paginated list responses

For collection endpoints (.../list), data itself wraps the array plus pagination metadata — confirmed across 30+ live list endpoints:

{
  "success": true,
  "message": "Retrieved successfully",
  "timestamp": "...",
  "correlation_id": "...",
  "data": {
    "data": [ { "...": "..." } ],
    "total_count": 214,
    "metrics": { }
  }
}

Field	Type	Description
`data.data`	array	The actual records for this page
`data.total_count`	integer	Total records matching the filter, across all pages
`data.metrics`	object	Present on most list endpoints; aggregate stats for the collection — shape varies per resource

Some collection endpoints (GET /api/v1/integration, GET /api/v1/notification/list’s sibling GET /api/v1/notification) return the array directly as data, without the data.data wrapper. Check the specific endpoint’s reference page for which shape it uses.

Status codes

Code	Meaning
`200`	Request succeeded
`401`	Missing, invalid, or expired bearer token — see Authentication
`404`	Resource not found (for example, an unknown `{id}` in the path)
`405`	Method not allowed for this path
`422`	Request validation failed, for example a required body field is missing
`500`	Unexpected server error

A couple of endpoints in the source collection redirect (307) to a trailing-slash form of the same path, and one documented as POST (/api/v1/governance/field-property) returned 405 Method Not Allowed live against both spellings. POST /api/v1/governance/product/{productId}/output-port returned 500 against a real product ID during capture. These look like small inconsistencies or bugs between the Postman collection and the live API — noted here rather than silently corrected or hidden, since they haven’t been confirmed with the API owners yet.

Error response body

Error responses keep the success, message, timestamp and correlation_id fields of the normal envelope. success is false, data is not returned, and these fields are added:

Field	Type	Description
`error_code`	string	Stable code for the kind of error, see the table below
`details`	object	Context for the error. Its shape depends on the error code
`endpoint`	string	The path that was called
`error_type`	string	Category of the error, for example `validation_error`, `resource_error` or `system_error`
`severity`	string	`low`, `medium` or `critical`

Error codes observed so far:

HTTP status	`error_code`	`error_type`	Typical cause
`404`	`RES_001`	`resource_error`	The resource ID in the path does not exist
`405`	`METHOD_001`	n/a	The path does not accept this HTTP method
`422`	`VALIDATION_002`	`validation_error`	The request body failed validation. `details.validation_errors` lists each problem
`500`	`INTERNAL_ERROR`	`system_error`	Unexpected server error. Quote the `correlation_id` when contacting support

For 401 responses, see Authentication.

Validation error (`422`)

The following response is returned when field/tabs-by-level is called without its required level field:

{
  "success": false,
  "message": "Request validation failed",
  "timestamp": "2026-09-21T10:30:06.928101+00:00",
  "correlation_id": "3249ef41-a745-4d3d-81a9-75d963390cde",
  "error_code": "VALIDATION_002",
  "details": {
    "validation_errors": [
      { "field": "body -> level", "message": "Field required", "type": "missing" }
    ]
  },
  "endpoint": "/api/v1/governance/field/tabs-by-level",
  "error_type": "validation_error",
  "severity": "medium"
}

Not found (`404`)

{
  "success": false,
  "message": "Alert cluster with ID 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found",
  "timestamp": "2026-09-21T10:32:08.232534+00:00",
  "correlation_id": "ba6a0fa2-0039-4caf-b0a5-312a75798b8d",
  "error_code": "RES_001",
  "details": { "cluster_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" },
  "endpoint": "/api/v1/metrics/alert-cluster/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "error_type": "resource_error",
  "severity": "low"
}

400, 403 and 409 responses are not documented because they have not been observed. This table will be extended as more error codes are confirmed.

Get Started

Core

Metrics

Schedule

Notification

Integrations

Governance

Logging

Response & Error Format

Response envelope

List, filter, sort, and search

Filter objects

Paginated list responses

Status codes

Error response body

Validation error (`422`)

Not found (`404`)

​Response envelope

​List, filter, sort, and search

​Filter objects

​Paginated list responses

​Status codes

​Error response body

​Validation error (422)

​Not found (404)

Response envelope

List, filter, sort, and search

Filter objects

Paginated list responses

Status codes

Error response body

Validation error (`422`)

Not found (`404`)