Viewing issue analytics and previewing monitor rules
On this page
This guide explains how to view issue analytics and preview custom monitor rules on a data extract using Connect API. For prerequisites, limitations, and how to select workspaces and list issues, see Managing Data Quality issues.
Viewing issue analytics
The following requests summarize issues across datastreams. All of them accept the parameters described in Selecting workspaces.
Scroll horizontally to see the full table.
Request | Parameters | What it returns |
|---|---|---|
|
| The datastreams with the most unacknowledged issues of this type, most issues first. Each item contains the |
|
| One item for each day with issues, newest day first. Each item contains the |
|
| The number of monitored datastreams with unacknowledged issues of this type ( |
A datastream counts as monitored when a universal monitor of the type is enabled for it, or, for the values type, when a custom monitor is assigned to it. datastreams scheduled for deletion are not counted.
The cURL request example is the following. It counts the issues of each day in October 2026:
curl --location --request GET 'https://{{INSTANCE}}/api/v1/monitors/issues/analytics/daily/?date_from=2026-10-01&date_to=2026-10-31' \
--header 'Authorization: Bearer {{KEY}}'
Previewing custom monitor rules on a data extract
Before you save a custom monitor, you can check its rules against the rows of a data extract to see which rows would violate them. The check saves nothing, so the rules do not need to belong to a monitor. For more information on the rules, see Working with custom monitors.
To preview custom monitor rules, follow these steps:
-
Create a POST request to the following endpoint:
https://{{INSTANCE}}/api/v1/monitors/preview/ -
In the HTTP request header, include the parameter
Authorizationwith valueBearer {{KEY}}. -
In the HTTP request header, include the parameter
Content-Typewith valueapplication/json. -
In the HTTP request body, include the following parameters:
Scroll horizontally to see the full table.
Parameter
Required
Description
extract_idYes
The numeric ID of the data extract whose rows to check.
blocksYes
The rule blocks to check, from 1 to 50. Each block has a
key(UUID) of your choice and acondition, in the same form as the rule blocks of a custom monitor.has_target_columnsNo
trueif the rules name the columns of the datastream’s schema instead of the source columns. Default:false.limitNo
The number of rows to check, from the start of the data extract. From
1to1000. Default:100. -
Send the request.
As a result, you obtain one item for each rule block, with the block’s key and violated_rows: the positions of the checked rows that violate the block, counted from 0.
[
{
"key": "54cdeeb5-1db4-494b-97ee-a48c5af66874",
"violated_rows": [0, 7, 42]
}
]
If the data extract does not exist, the key cannot see it, or its data is no longer stored, Connect API returns HTTP 404.
The cURL request example is the following. It checks one rule block on the first 100 rows of a data extract:
curl --location --request POST 'https://{{INSTANCE}}/api/v1/monitors/preview/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data '{"extract_id": {{EXTRACT_ID}}, "limit": 100, "blocks": [{"key": "54cdeeb5-1db4-494b-97ee-a48c5af66874", "representation": "date-format", "condition": {"key": "091610f9-52e1-44c1-92c0-514b453cdac2", "operation": "and", "conditions": [{"key": "9493426c-08da-413b-b449-00a0e32f6447", "operation": "or", "conditions": [{"key": "67122737-e878-4f2f-8479-222bf91417d2", "column": "Date", "columnType": 4, "operation": 16, "value": "2022-06-01"}]}]}}]}'