Skip to content
Book a demo

Connect documentation

All documentation
Documentation

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

GET https://{{INSTANCE}}/api/v1/monitors/issues/analytics/top-datastreams/

type (required): the issue type. limit: the number of datastreams, from 1 to 30. Default: 5.

The datastreams with the most unacknowledged issues of this type, most issues first. Each item contains the datastream (id and name) and its number of errors and warnings.

GET https://{{INSTANCE}}/api/v1/monitors/issues/analytics/daily/

date_from and date_to (required, YYYY-MM-DD): the period. date_to can be at most 366 days after date_from; a longer range returns HTTP 400. Optionally, the datastream_id, monitor_id, type, severity, and is_acknowledged filters described in Listing issues.

One item for each day with issues, newest day first. Each item contains the date, the number of unacknowledged errors and warnings, and the number of acknowledged issues. When you filter by severity or is_acknowledged, the counts that do not match the filter are 0.

GET https://{{INSTANCE}}/api/v1/monitors/issues/analytics/totals/

type (required): the issue type.

The number of monitored datastreams with unacknowledged issues of this type (datastreams_with_issues) and without them (datastreams_without_issues), the number of unacknowledged issues (issues), and the number of unacknowledged issues up to the end of yesterday in UTC (issues_yesterday). is_active is false if no monitor of this type watches any datastream.

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:

  1. Create a POST request to the following endpoint:

    https://{{INSTANCE}}/api/v1/monitors/preview/
    
  2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

  3. In the HTTP request header, include the parameter Content-Type with value application/json.

  4. In the HTTP request body, include the following parameters:

    Scroll horizontally to see the full table.

    Parameter

    Required

    Description

    extract_id

    Yes

    The numeric ID of the data extract whose rows to check.

    blocks

    Yes

    The rule blocks to check, from 1 to 50. Each block has a key (UUID) of your choice and a condition, in the same form as the rule blocks of a custom monitor.

    has_target_columns

    No

    true if the rules name the columns of the datastream’s schema instead of the source columns. Default: false.

    limit

    No

    The number of rows to check, from the start of the data extract. From 1 to 1000. Default: 100.

  5. 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"}]}]}}]}'